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

Entity Posting API - Distributor Add/Update

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

Triggered Updates:

• Distributor 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 Distributor Entity:

• ID attribute: Unique identifier for Distributor
  String
  (required)
• Name: Distributor name
  String
  (required)
• Tags: User defined list of tags they might want to filter on
  String
• Address: Distributor's registered address
  • Line1: Line1 of distributor's registered address
    String
  • Line2: Line2 of distributor's registered address
    String
  • Line3: Line3 of distributor's registered address
    String
  • Town: Town/City of distributor's registered address
    String
  • Region: Region/County of distributor's registered address
    String
  • Country: Country of distributor's registered address
    String
    (required)
  • PostCode: Postcode/Zip code of distributor's registered address
    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>
	<Distributors>
		<Distributor id="XXX">
			<Name>XXX</Name>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<Address id="XXX">
				<Line1>XXX</Line1>
				<Line2>XXX</Line2>
				<Line3>XXX</Line3>
				<Town>XXX</Town>
				<Region>XXX</Region>
				<Country>XXX</Country>
				<PostCode>XXX</PostCode>
			</Address>
		</Distributor>
	</Distributors>
</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 Distributor, 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="Distributor">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>