Follow

Feed API Return Values

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 examples detail the ungrouped list of events when the showslist parameter is not used.
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.
ArrayOfEvent
 
list
The List of Events containing the following fields
EventID
 
long
The event ID
ExternalEventID
 
string
The external event ID
ParentEventID
 
long
The parent event ID. When dealing with shows and showings this will be the main show a showing is tied to.
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 event
DateTBD
 
bool
The date/time of the event is still to be determined
StartDate
 
datetime
The start date/time of the event
EndDate
 
datetime
The enddate/time of the event
ShowEndDate
 
bool
The end date should be shown when displaying the event
ShowTime
 
bool
The time should be shown when displaying the event
Type
 
string
The type of event
ShortDescription
 
string
The short description for the event
ShortDescriptive1
 
string
The supporting text for an event name
ShortDescriptive2
 
string
The supporting text for an event date/time
ExtraHTML
 
string
The extra HTML/Text for the event
DisplayColor
 
int
The display color for the event
EventImage
 
string
The image name
EventThumbImage
 
string
The thumbnail image name
ConfigImage
 
string
The venue config image name
ConfigThumbImage
 
string
The venue config thumbnail image name
SalesMessage
 
string
The current sales message to display
SalesState
 
int
The current sales status (BeforeSales, DuringSales, AfterSalesBeforeEvent, AfterEvent, or DisplayCustomMessage)
BuyLink
 
string
The URL to the legacy purchase page for the event
InfoLink
 
string
The URL to the purchase page for the 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
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)
Venue
The venue information for this event
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
Custom Property
Extra defined properties for the event
Name
 
string
The name of the property
Group
 
string
The group for the property
Sequence
 
int
The display sequence for sorting properties
Hidden
 
bool
Whether the property should be displayed or used for internal purposes
Value
 
string
The value of the property
AdditionalMedia
 
list
The list of Additional Media set for this event
Caption
 
string
The caption or alt value for the media
MainDuplicate
 
bool
Is this the main image defined for the event
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
Example XML Response
<ATSFeed xmlns="http://www.agiletix.com">
  <SourceLink><![CDATA[URL String content]]></SourceLink>
  <LastUpdated UpdateFrequencyMinutes="30">2014-06-12T16:02:20</LastUpdated>
  <ArrayOfEvent>
    <Event>
      <EventID>9223372036854775807</EventID>
      <ExternalEventID>String content</ExternalEventID>
      <ParentEventID>-1</ParentEventID>
      <CorpOrgID>9223372036854775807</CorpOrgID>
      <CorpOrgName>![CDATA[String content]]></CorpOrgName>
      <OrgID>9223372036854775807</OrgID>
      <Folder><![CDATA[String content]]></Folder>
      <Name><![CDATA[String content]]></Name>
      <DateTBD>false</DateTBD>
      <StartDate>1999-05-31T11:20:00</StartDate>
      <EndDate>1999-05-31T11:20:00</EndDate>
      <ShowEndDate>false</ShowEndDate>
      <ShowTime>true</ShowTime>
      <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>String content</ExtraHTML>
      <DisplayColor>FFFFFF</DisplayColor>
      <EventImage><![CDATA[URL String content]]></EventImage>
      <EventThumbImage><![CDATA[URL String content]]></EventThumbImage>
      <ConfigImage><![CDATA[URL String content]]></ConfigImage>
      <ConfigThumbImage><![CDATA[URL String content]]></ConfigThumbImage>
      <SalesMessage><![CDATA[Buy Tickets]]></SalesMessage>
      <SalesState>DuringSales</SalesState>
      <BuyLink><![CDATA[URL String content]]></BuyLink>
      <InfoLink><![CDATA[URL String content]]></InfoLink>
      <PurchasePrompt><![CDATA[URL String content]]></PurchasePrompt>
      <MoreInfoPrompt><![CDATA[URL String content]]></MoreInfoPrompt>
      <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>
      <Venue>
        <VenueID>9223372036854775807</VenueID>
        <VenueShort><![CDATA[String content]]></VenueShort>
        <VenueName><![CDATA[String content]]></VenueName>
        <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>
      <CustomProperties>
        <CustomProperty>
          <Name><![CDATA[String content]]></Name>
          <Group><![CDATA[String content]]></Group>
          <Sequence>9223372036854775807</Sequence>
          <Hidden>false</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>
    </Event>
  </ArrayOfEvent>
</ATSFeed>
Example JSON Response
{
  "SourceLink": "FEEDURL",
  "LastUpdated": "2018-01-01T15:59:01",
  "UpdateFrequencyMinutes": 10,
  "ArrayOfEvent": [
    {
      "EventID": 1231234,
      "ExternalEventID": "1231234",
      "ParentEventID": 1231233,
      "CorpOrgID": 10583,
      "CorpOrgName": "Agile Theatre",
      "OrgID": 10630,
      "Folder": "Films",
      "Name": "THE GOSPEL ACCORDING TO ANDRÉ",
      "DateTBD": false,
      "StartDate": "2018-09-05T14:20:00",
      "EndDate": "2018-09-05T15:53:00",
      "ShowEndDate": false,
      "ShowTime": true,
      "Type": "Feature",
      "ShortDescription": "Dir. Kate Novack | USA | 2018 | 93 min. | PG-13 | DCP",
      "ShortDescriptive1": "",
      "ShortDescriptive2": "",
      "ExtraHTML": "",
      "DisplayColor": "0080FF",
      "EventImage": "IMAGEURL",
      "EventThumbImage": "THUMBURL",
      "ConfigImage": "URL",
      "ConfigThumbImage": "URL",
      "SalesMessage": "Buy Tickets",
      "SalesState": "During Sales",
      "BuyLink": "LegacyPurchaseURL",
      "InfoLink": "InfoPageURL",
      "PurchasePrompt": "Buy Now",
      "MoreInfoPrompt": "More Info",
      "StreamingEnabled": true,
      "StreamingType": "TYPEVAL",
      "StreamingID": "ID OR URL",
      "StreamingWindowType": "WINDOWVAL",
      "StreamingHours": 48,
      "StreamingWatchURLOverride": "StreamingURL",
      "StreamingPrompt": "Watch Now",
      "StreamingGeoBlocking": "USCanada", 
      "Venue": {
        "VenueID": 4110,
        "Name": "Agile Screen B",
        "Short": "ASB",
        "Address1": "3810 Central Pike",
        "Address2": "",
        "City": "NASHVILLE",
        "State": "TN",
        "Zip": "37076"
      },
      "CustomProperties": [],
      "AdditionalMedia": [],
      "RelatedEvents": []
    }]
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments