The WebSales Feed returns a list of events/showtimes or other product data based on the Entry Point settings defined in the Agile Ticketing backend. The result set differs based on whether the showslist parmater is used in the GET request. The following example details the grouped list of shows and showings when the showslist parameter is equal to “true”.
Return Values
SourceLink
string
The URL used for the Feed request
LastUpdated
datetime
The date and time that the feed data was refreshed. The data is cached on the Agile server for a certain frequency. The UpdateFrequencyMinutes attribute shows how often this data is refreshed on the server.
ArrayOfShows
list
The list of Shows containing the following fields
ID
long
The show ID
ExternalID
string
The external ID
CorpOrgID
int
The top level organization ID
CorpOrgName
string
The name of the organization
OrgID
int
The event level organization ID
Folder
string
The event level folder name
Name
string
The name of the show
Duration
int
The duration of the show in minutes
Type
string
The type of the show
ShortDescription
string
The short description for the show
ShortDescriptive1
string
The supporting text for the show name
ShortDescriptive2
string
The supporting text for a show’s date/time
ExtraHTML
string
The extra HTML/Text for the show
DisplayColor
int
The display color for the show
ThumbImage
string
The thumbnail image name
EventImage
string
The image name
InfoLink
string
The URL for the info page for this show and all showings
StreamingEnabled
bool
Whether streaming is enable for this show or not
StreamingType
string
The type of video streaming source. (Vimeo, VimeoLive, VimeoShowcase, CineSend, CineSendVoucher, ExternalURL, EmbedURL, PurchaseURL, ZoomMeeting, Brightcove, AgileLINK, AgileLINKVoucher)
StreamingID
string
The streaming asset ID or URL for integration
StreamingWindowType
string
The type of availability for streaming. (FirstWatch, PurchaseDate, StartDate, EndDate, OpenToMembers, OpenToAll)
StreamingHours
int
The number of hours streaming is available
StreamingWatchURLOverride
string
The URL for overriding where to send the customer for viewing the streaming title
StreamingPrompt
string
The “Watch Now” prompt to show the customer to start the stream
StreamingGeoBlocking
string
The Geo Blocking applied to the streaming title (Default, SameState, SameCountry, USCanada, or integer value of radius around organization zip code)
CustomProperties
list
The list of Custom Properties set for this show
Name
string
The name of the custom property
Group
string
The group the custom property belongs to
Sequence
int
The value to sort the custom property by within the group
Hidden
bool
Should this custom property be hidden from the customer view
Value
string
The value of the custom property
AdditionalMedia
list
The list of Additional Media set for this show
Caption
string
The caption or alt value for the media
MainDuplicate
bool
Is this the main image defined for the show
Sequence
int
The value to sort the media by
Type
string
The type of media element (Image, HTML, Youtube, Vimeo)
Value
string
The underlying value of the media element (Image URL, Youtube URL, Vimeo URL, HTML block)
MediaEmbed
string
The media element in it’s embeddable form (img tag, Youtube embed code, Vimeo embed code, HTML block)
Related Event
Other events that are related to this event such as with shorts programs
ID
int
The ID of the related event
OrgID
int
The event level organization ID
Name
string
The name of the related event
UntilDate
datetime
The Date and time of the related event
Duration
int
The duration of the event in minutes
ShortDescriptive
string
A secondary description line for the related event
ImageURL
string
the URL for the related events image
ThumbnailURL
string
The URL for the related events thumbnail image
Description
string
The description for the related event
InfoLink
string
The URL to the purchase page for the related event
CurrentShowings
list
The list of current showings for this show
ID
long
The showing ID
DateTBD
bool
The date/time of the showing is still to be determined
StartDate
datetime
The start date/time of the showing
EndDate
datetime
The enddate/time of the showing
Duration
int
The duration of the showing in minutes. This value can differ from the show’s default duration.
Type
string
The type of the showing.
ShortDescriptive
string
The supporting text for a showings’s date/time
ShortDescription
string
The short description for the showing
SalesMessage
string
The current sales message to display
SalesState
int
The current sales status (BeforeSales, DuringSales, AfterSalesBeforeEvent, AfterEvent, or DisplayCustomMessage)
LegacyPurchaseLink
string
The URL for the old purchase pipeline for a single event
PurchasePrompt
string
The “Buy Tickets” prompt that should be shown to customers to start purchase
MoreInfoPrompt
string
The “More Info” prompt that should be shown to customers to see more details about the event/title
Venue
The venue information for this showing
VenueID
int
The venue ID
VenueName
string
The name of the venue
VenueShort
string
The short name of the venue
VenueAddress1
string
Address line 1 for the venue
VenueAddress2
string
Address line 2 for the venue
VenueCity
string
The city where the venue is located
VenueState
string
The state/Province where the venue is located
VenueZip
string
The zip/postal code where the venue is located
Example XML Response
<ATSFeed xmlns="http://www.agiletix.com"> <SourceLink><![CDATA[URL String content]]></SourceLink> <LastUpdated UpdateFrequencyMinutes="30">2014-06-12T16:16:42</LastUpdated> <ArrayOfShows> <Show> <ID>9223372036854775807</ID> <ExternalID>String Content</ExternalID> <CorpOrgID>9223372036854775807</CorpOrgID> <CorpOrgName>![CDATA[String content]]></CorpOrgName> <OrgID>9223372036854775807</OrgID> <Folder><![CDATA[String content]]></Folder> <Name><![CDATA[String content]]></Name> <Duration>120</Duration> <Type><![CDATA[String content]]></Type> <ShortDescription><![CDATA[Short Description String content]]></ShortDescription> <ShortDescriptive1><![CDATA[Name Secondary String content]]></ShortDescriptive1> <ShortDescriptive2><![CDATA[Date Secondary String content]]></ShortDescriptive2> <ExtraHTML><![CDATA[String content]]></ExtraHTML> <DisplayColor>FFFF00</DisplayColor> <ThumbImage><![CDATA[URL string content]]></ThumbImage> <EventImage><![CDATA[URL string content]]></EventImage> <InfoLink><![CDATA[URL string content]]></InfoLink> <StreamingEnabled>True/False</InfoLink> <StreamingType>string content</StreamingType> <StreamingID><![CDATA[ID or URL string content]]></StreamingID> <StreamingWindowType>string content</StreamingWindowType> <StreamingHours>922337203685</StreamingHours> <StreamingWatchURLOverride><![CDATA[URL string content]]></StreamingWatchURLOverride> <StreamingPrompt><![CDATA[string content]]></StreamingPrompt> <StreamingGeoBlocking>string content</StreamingGeoBlocking> <CustomProperties> <CustomProperty> <Name><![CDATA[String content]]></Name> <Group><![CDATA[String content]]></Group> <Sequence>0</Sequence> <Hidden>false</Hidden> <Value><![CDATA[String content]]></Value> </CustomProperty> <CustomProperty> <Name><![CDATA[String content]]></Name> <Group><![CDATA[String content]]></Group> <Sequence>1</Sequence> <Hidden>true</Hidden> <Value><![CDATA[String content]]></Value> </CustomProperty> </CustomProperties> <AdditionalMedia> <Media> <Caption><![CDATA[String content]]></Caption> <MainDuplicate><![CDATA[True/False]]></MainDuplicate> <Sequence>9223372036854775807</Sequence> <Type>Image/Youtube/Vimeo/HTML</Type> <Value><![CDATA[String content]]></Value> <MediaEmbed><![CDATA[String content]]></MediaEmbed> </Media> <Media> <Caption><![CDATA[String content]]></Caption> <MainDuplicate><![CDATA[True/False]]></MainDuplicate> <Sequence>9223372036854775807</Sequence> <Type>Image/Youtube/Vimeo/HTML</Type> <Value><![CDATA[String content]]></Value> <MediaEmbed><![CDATA[String content]]></MediaEmbed> </Media> <AdditionalMedia> <RelatedEvents> <RelatedEvent> <ID>9223372036854775807</ID> <OrgID>9223372036854775807</OrgID> <Name>Related Event Name</Name> <UntilDate>yyyy-MM-ddTHH:mm:ss</UntilDate> <Duration>9223372036854775807</Duration> <ShortDescriptive><![CDATA[String content]]></ShortDescriptive>" <ImageURL><![CDATA[URL String content]]></ImageURL> <ThumbnailURL><![CDATA[URL String content]]></ThumbnailURL> <Description><![CDATA[String content]]></Description> <InfoLink><![CDATA[URL String content]]></InfoLink> </RelatedEvent> </RelatedEvents> <CurrentShowings> <Showing> <ID>9223372036854775807</ID> <DateTBD>false</DateTBD> <StartDate>1999-05-31T11:20:00</StartDate> <EndDate>1999-05-31T11:20:00</EndDate> <Duration>120</Duration> <Type><![CDATA[String content]]></Type> <ShortDescriptive><![CDATA[Date Secondary String content]]></ShortDescriptive> <ShortDescription><![CDATA[Short Description String content]]></ShortDescription> <SalesMessage><![CDATA[Buy Tickets String content]]></SalesMessage> <SalesState>DuringSales</SalesState> <LegacyPurchaseLink><![CDATA[URL String content]]></LegacyPurchaseLink> <PurchasePrompt><![CDATA[URL String content]]></PurchasePrompt> <MoreInfoPrompt><![CDATA[URL String content]]></MoreInfoPrompt> <Venue> <VenueID>9223372036854775807</VenueID> <VenueName><![CDATA[String content]]></VenueName> <VenueShort><![CDATA[String content]]></VenueShort> <VenueAddress1><![CDATA[String content]]></VenueAddress1> <VenueAddress2><![CDATA[String content]]></VenueAddress2> <VenueCity><![CDATA[String content]]></VenueCity> <VenueState><![CDATA[String content]]></VenueState> <VenueZip><![CDATA[String content]]></VenueZip> </Venue> </Showing> </CurrentShowings> </Show> </ArrayOfShows> </ATSFeed>
Example JSON Response
{ "SourceLink": "FEEDURL", "LastUpdated": "2018-01-01T15:59:01", "UpdateFrequencyMinutes": 10, "ArrayOfShows": [ { "ID": 123123, "ExternalID": "123123", "CorpOrgID": 10583, "CorpOrgName": "Agile Theatre", "OrgID": 123123, "Folder": "Films", "Name": "Show Name A", "Duration": 105, "Type": "Feature", "ShortDescription": "Description", "ShortDescriptive1": "Desc1", "ShortDescriptive2": "Desc2", "ExtraHTML": "", "DisplayColor": "FF8040", "EventImage": "IMAGEURL", "ThumbImage": "THUMBURL", "InfoLink": "InfoPageURL", "StreamingEnabled": true, "StreamingType": "TYPEVAL", "StreamingID": "ID OR URL", "StreamingWindowType": "WINDOWVAL", "StreamingHours": 48, "StreamingWatchURLOverride": "StreamingURL", "StreamingPrompt": "Watch Now", "StreamingGeoBlocking": "USCanada", "CustomProperties": [], "AdditionalMedia": [], "RelatedEvents": [], "CurrentShowings": [ { "ID": 125786, "DateTBD": false, "StartDate": "2018-10-25T19:00:00", "EndDate": "2018-10-25T20:45:00", "Duration": 105, "Type": "Feature", "ShortDescriptive": "", "ShortDescription": "Presented by Agile\nDoors at 6:30pm | Show at 7:00pm", "SalesMessage": "Buy Tickets", "SalesState": "DuringSales", "LegacyPurchaseLink": "LegacyPurchaseURL", "PurchasePrompt": "Buy Now", "MoreInfoPrompt": "More Info", "Venue": { "VenueID": 485, "Name": "Agile Screen A", "Short": "ASA", "Address1": "3810 Central Pike", "Address2": "", "City": "NASHVILLE", "State": "TN", "Zip": "37076" } } ] }] }
Comments