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

Entity Posting API - Site Add/Update

If the SiteID does not exist, a new Site record will be created. If it does, it will be updated.

Triggered Updates:

• The site name, type, groups, hall names and types for any existing transactions with the 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 Site Entity:

• ID attribute: Unique identifier for site
  String
  (required)
• Name: Site name
  String
  (required)
• Type: Base categorisation for site
  String
• Tags: User defined list of tags they might want to filter on
  String
• DefaultLanguage: Default language the people who operate the site work in
  ISO-639-1 Code e.g. en
• DefaultCurrency: Default Currency the people who operate the site work in
  ISO-4217 Code e.g. USD
• Address: Site's location
  • Line1: Line1 of site's location
    String
  • Line2: Line2 of site's location
    String
  • Line3: Line3 of site's location
    String
  • Town: Town/City of site's location
    String
  • Region: Region/County of site's location
    String
  • Country: Country of site's location
    String
    (required)
  • PostCode: Postcode/Zip code of site's location
    String
  • Latitude: Geo coordinates of site
    Float
  • Longitude: Geo coordinates of site
    Float
• Halls: List of halls in the site (min 1 required)
  • ID attribute: Unique identifier for hall
    String
    (required)
  • Name: Hall name
    String
    (required)
  • Type: Base categorisation for hall
    String
  • Tags: User defined list of tags they might want to filter on
    String
  • HearingLoopEnabled: Is the hall enabled for the Hearing Loop system (default false)
    true/false
  • Capacity: The total number of people the hall can hold
    Integer
• Website: Url of the website for the site
  String
• FacebookRefreshToken: Access token to allow us to mine Facebook data for site
  String
• TwitterRefreshToken: Access token to allow us to mine Twitter data for site
  String
• GoogleAnalyticsRefreshToken: Access token to allow us to mine Google Analytics data for site
  String
• YoutubeRefreshToken: Access token to allow us to mine Youtube data for site
  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>
	<Sites>
		<Site id="XXX">
			<Name>XXX</Name>
			<Type>XXX</Type>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<DefaultLanguage>XXX</DefaultLanguage>
			<DefaultCurrency>XXX</DefaultCurrency>
			<Address id="XXX">
				<Line1>XXX</Line1>
				<Line2>XXX</Line2>
				<Line3>XXX</Line3>
				<Town>XXX</Town>
				<Region>XXX</Region>
				<Country>XXX</Country>
				<PostCode>XXX</PostCode>
				<Latitude>XXX</Latitude>
				<Longitude>XXX</Longitude>
			</Address>
			<Halls>
				<Hall id="XXX">
					<Name>XXX</Name>
					<Type>XXX</Type>
					<Tags>
						<Tag>XXX</Tag>
					</Tags>
					<HearingLoopEnabled>XXX</HearingLoopEnabled>
					<Capacity>XXX</Capacity>
				</Hall>
			</Halls>
			<Website>XXX</Website>
			<FacebookRefreshToken>XXX</FacebookRefreshToken>
			<TwitterRefreshToken>XXX</TwitterRefreshToken>
			<GoogleAnalyticsRefreshToken>XXX</GoogleAnalyticsRefreshToken>
			<YoutubeRefreshToken>XXX</YoutubeRefreshToken>
		</Site>
	</Sites>
</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 site, 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="Site">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>