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

Entity Posting API - Performance Add/Update

If the PerformanceId does not exist, a new Performance record will be created. If it does, it will be updated.

NOTE: There are many fields which are required for a Performance but in many integrations, the required data is fed from disperate systems so we allow partial messages to be sent with only available fields and we will merge them to form complete entity. The complete Performance entity should contain the required fields denoted by *

Triggered Updates:

• The types, date, time, print formats, runweek, ispreview, hall, occupancy rates and distributor percentages for any existing transactions with the PerformanceId and SiteID will be updated

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 Performance Entity:

• ID attribute: Unique identifier for performance
  String
  (required)
• SiteID attribute: Unique identifier for site that the performance applies to
  String
  (required)
• EventId: Unique identifier for event that the performance applies to (link to Event entity)
  String
  *
• DistributorId: Unique identifier for Distributor (link to Distributor entity)
  String
• Tags: User defined list of tags they might want to filter on
  String
• Date: Date of the performance
  yyyy-mm-dd
  *
• CinemaDate: If POS has specific rules to set reporting date on an performance, this field can be used to overwrite Showtime derived date
  yyyy-mm-dd
• Time: Time of the day the performance starts
  hh:mm
  *
• IsCancelled: Flag to indicate the performance was cancelled, all ticket orders for this performance will be invalidated (default false)
  true/false
• PrintFormats: List of Print Formats for the performance e.g. 3D, IMAX, ATMOS etc
  String
  *
• LangFormats: List of Language Formats for the performance e.g. English, German Subtitle, Dubbed etc
  String
• Attributes: Some POS only store a list of attributes against the performance. These will typically contain Print Formats and Audio Formats. Sent as a list
  String
• RunWeek: The number of weeks the event has been running
  Integer
• IsPreview: If the performance is a special preview performance outside of standard run weeks (default false)
  true/false
• FreeListSuspended: If the performance is flagged as "free list suspended"
  true/false
• HallId: Unique identifier for the hall (screen) that the performance is showing in (link to Hall under Site entity)
  String
  *
• OnSale: Set to false if performance is currently not available to purchase tickets for. This will prevent it showing in any active show times (default: true)
  true/false
• SeatCapacities: List of the number of seats of the hall by category
  • SeatType: Categorization of a block of seats. This will need to be the same SeatType passed in the TicketSale entity in the order for working out accurate capacities
    String
    (required)
  • Capacity: The number of seats in the seat block
    Integer
    (required)
• DistributorPercentage: The percentage of the profit for the performance that will be paid to the distributor
  Integer
  • Precision attribute: The number of decimal places in the DistributorPercentage field
    Integer
    (required)
• DistributorRate: The calculated amount for the performance that will be paid to the distributor
  Integer
  • Precision attribute: The number of decimal places in the DistributorRate field
    Integer
    (required)

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>
	<Performances>
		<Performance id="XXX" siteId="XXX">
			<EventId>XXX</EventId>
			<DistributorId>XXX</DistributorId>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<Date>XXX</Date>
			<CinemaDate>XXX</CinemaDate>
			<Time>XXX</Time>
			<IsCancelled>XXX</IsCancelled>
			<PrintFormats>
				<PrintFormat>XXX</PrintFormat>
			</PrintFormats>
			<LangFormats>
				<LangFormat>XXX</LangFormat>
			</LangFormats>
			<Attributes>
				<Attribute>XXX</Attribute>
			</Attributes>
			<RunWeek>XXX</RunWeek>
			<IsPreview>XXX</IsPreview>
			<FreeListSuspended>XXX</FreeListSuspended>
			<HallId>XXX</HallId>
			<OnSale>true/false</OnSale>
			<SeatCapacities>
				<SeatCapacity>
					<SeatType>XXX</SeatType>
					<Capacity>XXX</Capacity>
				</SeatCapacity>
			</SeatCapacities>
			<DistributorPercentage precision="XXX">XXX</DistributorPercentage>
			<DistributorRate precision="XXX">XXX</DistributorRate>
		</Performance>
	</Performances>
</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 performance, 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" siteId="XXX" entity="Performance">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>