To access this service, Maritz will provide you with:
Access to most services require authentication. The authentication mechanism is HTTP Basic auth over HTTPS. You will be provided with a Username and Password by Maritz to use with all such requests.
NOTE that these services should ONLY ever be accessed via HTTPS, never plain HTTP. You should not rely on HTTP-to-HTTPS redirection.
An up-to-date list of available entities can be obtained via a request to the EntitySchema method.
Entities with BaseType="SchemaEntityRoot" are "root-level" feeds that can be requested at Feed*, where
* is the entity's Name. Other entities in the list may be found as embedded objects inside other entities within
those feeds.
Start each feed by performing a GET request to it, with the EventCode as the "Event" querystring parameter.
Within each response, you will get a list of entities, and a NextSince value. Store the NextSince value in your local database, and put it in the "Since" querystring parameter to get the next page. You have reached the end of the feed (for now) when no entities are returned; sleep for a while, and then check again later.
Each entity has a couple of specific identifiers:
This endpoint provides global summary data about all Entity feeds, and can be used to get a list of all events to which you have access, and to speed up the feed process in the case of small incremental updates, where most entity types do not have any updates. This service should be called once, at the beginning of a feed cycle, after the sleep period.
Get the feed summary by performing a GET request to the "FeedMeta" service.
The response document will contain an object whose keys are the event codes, and whose values are the metadata object for each corresponding event. The metadata objects are objects whose keys are the feed types, and whose values are the maximum stamp value for that feed. Feeds that have no data may be omitted.
For each feed, if your local Next Since Value is less than the value in the summary, then there are new records in that feed, and you should start downloading them, by resuming the feed from your local Next Since value. If your local Next Since Value is not less than the value in the summary, then there are no new records in this feed, and you can skip it for this cycle.
Note that you may continue to receive records after you have reached the end of the feed as indicated by the metadata summary value. The metadata summary is a snapshot, and is only valid at the time it is requested, and new records may be added to the feeds at any time, including while they are being retrieved.
This endpoint provides a list of all events the user has access to, as well as stored metadata about the event such as:
Raw binary files (e.g. for attachments) are accessed via the "Asset" service.
Any entity may contain an array of "Attachment" entities. In addition to metadata about the attachment, these entities will contain a ChunkFileKey field, containing a short string. This string is the key used to retrieve the binary file content.
To fetch file content, perform a GET request to the "Asset" endpoint, with the event code passed as the "Event" querystring parameter, and the Attachment's ChunkFileKey passed as the "Key" querystring parameter.
Note that the binary content for a file with a given key will always be the same, and can be cached forever. This is also true across events: files with the same key, in different events, will still have the same content. If you have already downloaded any file with the same key, you can use your cached copy and do not need to download it again.
You will receive a binary ("application/octet-stream") response with the raw file content. The correct MIME type information may be available in the Attachment metadata (or you may have to probe the contents to infer it).
Sample implementations of consuming a feed in various programming languages are available at