• Entity Posting API
• >>
• Sale Device Add/Update

Entity Posting API - Sale Device Add/Update

Sale Device: The unique reference to the medium (terminal/app/atm) used to fulfill the transaction e.g. Boxoffice terminal, web/online. The type should be used to categorize (group)
If the SaleDeviceId does not exist, a new Sale Device record will be created. If it does, it will be updated.

Triggered Updates:

• No other data effected

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 Sale Device Entity:

• ID attribute: Unique identifier for Sale Device
  String
  (required)

• SiteID attribute: Unique identifier for site that the Sale Device applies to. Only populated if Sale Device is local to the site
  String
• Name: Name for Sale Device
  String
  (required)
• Type: Base categorisation for Sale Device
  String
• ThirdPartyAppId: ID common across chain to identify specific third party apps
  String
• Tags: User defined list of tags they might want to filter on
  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>
	<SaleDevice>
		<SaleDevice id="XXX" siteId="XXX">
			<Name>XXX</Name>
			<Type>XXX</Type>
			<ThirdPartyAppId>XXX</ThirdPartyAppId>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
		</SaleDevice>
	</SaleDevices>
</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 Sale Device, 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="SaleDevice">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>