Posting API - Posting Overview
Sequence Diagram
The sequence of events for successful processing of message from a data provider is as follows:
- A Triggered by an update to one or more entities or the completion of one or more transactions, the data provider will generate a message containing all updated entities
- B Message listener receives message containing one or many entities, authenticates dataprovider credentials (in HTTP header) and validates message structure (against schema). If determined to be valid, it is added to message processing queue
- C HTTP response code 200 returned to the dataprovider. Data provider marks that message as status "received"
- D Message Processor thread "pops" next message from the queue (first in first out basis) and unwrapped and each entity which is processed autonomously
- E Processing of each entity will result in new summarized data being written for consumption by the ShowTime Analytics frontend application
- F Once full message is processed, a response message is posted back to the dataprovider's callback URL (send as a part of the message). The data provider will flag the message as status "complete"
Message Size
The Maximum permitted message size is 256KB, any messages above this limit will be rejected and will need to be split into multiple smaller messages.
Encryption
The API is entirely HTTP-based and all data transferred using HTTPS (over SSL)
XML Format Notes
- All String datatypes must be wrapped in CDATA tags
- All numbers are passed as Integer values. If there are decimal values, they need to be represented via the Precision attribute on the element