• Entity Posting API
• >>
• Event Add/Update

Entity Posting API - Event Add/Update

We will try to map the EventId to our existing master list of events. If we cannot find a mapping, we will create it as a new mapping to our "Other" master Event. It will be determined offline if this represents a new event or a new mapping and all data will be remapped accordingly.

We do not maintain mappings from Events to distributors as distributors vary for events from region to region. Distributors are mapped in the performance entity.

Triggered Updates:

• Event details will be pushed to frontend as a part of a separate offline review process

Standard ShowTimeAnalytics Message Parameters:

• DataSupplierID: Assigned unique identifier for your account
  String
  (required)
• MessageSequence: Unique sequence number incremented for each message posted
  Long
  (required)
• CallbackUrl: Dataprovider defined URL that result of processing the message is posted back to
  String

Fields for Event Entity:

• ID attribute: Unique identifier for Event
  String
  (required)
• SiteID attribute: Unique identifier for site that the Event applies to. Only populated if Event is local to the site
  String
• Name: Event name
  String
  (required)
• Types: List of base categorisations for event
  String
• Tags: User defined list of tags they might want to filter on
  String
• Runtime: Length in minutes the event runs for
  Integer
• Ratings: List of individual Country age/maturity ratings.
  • Country: Country which rating applies to
    String
    (required)
  • RatingValue: Rating value which conforms to Country standards e.g. 15A
    String
    (required)
• RentrakID: Specific field for Cinema customers. Unique Rentrak identifier for Event
  String
• NationalUnifiedId: Unique Nationally assigned identifier for Event
  String
• ReleaseDates: List of individual Country release dates.
  • Country: Country which release date applies to
    String
    (required)
  • ReleaseDate: Date event is released in specified country
    yyyy-mm-dd
    (required)
• Genre: List of genres which further categorize the event e.g. Comedy/Thriller
  String
• ImdbID: Specific field for Cinema customers. Unique Imdb identifier for Event
  String
• RottenTomatoesID: Specific field for Cinema customers. Unique RottenTomatoes identifier for Event
  String
• YoutubeID: Specific field for Cinema customers. Unique youtube identifier for Event
  String
• EventWebsite: Link to the official website of the event
  String

PLEASE NOTE: All field and attribute names are case sensitive

Message Structure - XML:

<?xml version="1.0" encoding="UTF-8"?>
<ShowTimeAnalytics dataSupplierId="XXX" messageSequence="XXX">
	<CallbackUrl>https://XXX</CallbackUrl>
	<Events>
		<Event id="XXX" siteId="XXX">
			<Name>XXX</Name>
			<Types>
				<Type>XXX</Type>
			</Types>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<Runtime>XXX</Runtime>
			<Ratings>
				<Rating>
					<Country>XXX</Country>
					<RatingValue>XXX</RatingValue>
				</Rating>
			</Ratings>
			<NationalUnifiedId>XXX</NationalUnifiedId>
			<RentrakId>XXX</RentrakId>
			<ReleaseDates>
				<ReleaseDate>
					<Country>XXX</Country>
					<ReleaseDateValue>YYYY-mm-DD</ReleaseDateValue>
				</ReleaseDate>
			</ReleaseDates>
			<Genres>
				<Genre>XXX</Genre>
			</Genres>
			<YoutubeId>LCoI3DdstZw</YoutubeId>
			<ImdbId>XXX</ImdbId>
			<RottenTomatoesId>XXX</RottenTomatoesId>
			<EventWebsite><XXX></EventWebsite>
		</Event>
	</Events>
</ShowTimeAnalytics>

Callback Post Fields:

• DataSupplierID: Unique identifier for your account, same as passed in post message
• MessageSequence: Unique sequence number for message, same as passed in post message
• ID attribute: Unique identifier for Event, same as passed in post message
• Status: Processing result flag - ok/error
• Error: If the status flag is "error", list of warning messages during processing

Message Structure - XML:

<?xml version="1.0" encoding="UTF-8"?>
<ShowTimeAnalyticsResponse dataSupplierId="XXX" messageSequence="XXX">
    <Responses>
        <Response id="XXX" entity="Event">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>