The guid parameter is the only required parameter for the WebSales Feed. The Entry Point settings in Agile define which events to return and the date range. Most of the parameters below provide a way to filter the results from the default return set. The showslist parameter is important to look at since it changes the way the data is grouped and returned.
Parameters
guid
string
The unique identifier for the Entry Point link in the Agile system.
format
string
optional
The format for the data to be returned as. If left out this will default to XML to request JSON the format parameter should be “json”
startdate
datetime
optional
The starting date to filter event dates by. By default the Entry Point in Agile defines the startdate parameter for the XML Feed. If you define the startdate parameter you must also provide an enddate.
enddate
datetime
optional
The ending date to filter events dates by. By default the Entry Point in Agile defines the enddate parameter for the XML Feed. If you define the enddate parameter you must also provide a startdate.
showslist
boolean
optional
Set to “true” if you want to get the data as Shows with Showings grouped underneath. Without this parameter the feed will return a flat event return set. This parameter is pretty important as it changes the structure of the data returned. For more information about how the structure is changed see the Return Values examples and ReturnValues (showlist=true) examples.
kw
string
optional
Keyword search the films to get matching items.
venueid
long
optional
The Agile venue identifier to subset the results to.
cpdata
boolean
optional
Set to “true” to add the full list of custom properties for the organization including suggested values to the return set.
cphide
boolean
optional
Set to “true” to hide custom properties on events/shows from the return set.
fulldescription
boolean
optional
Set to “true” to include full descriptions in addition to the short description in the return set.
withmedia
boolean
optional
Set to “true” to include the full list of images, videos, and embedded media content in the return set.
showid
long
optional
Only return the film and it’s screenings based on the Agile show identifier.
eventid
long
optional
Find the particular screening based on the Agile event identifier.
exteventid
string
optional
Find the particular film/screening based on the user defined external event identifier.
cp(id)
boolean
optional
Find the particular film/screening based on the value of a particular custom property. Example: For a custom property with ID of 123 where you want to match value of "Coming Soon" the parameter should be formatted as "cp123=Coming Soon&".
cp(name)
boolean
optional
Find the particular film/screening based on the value of a particular custom property. Example: For a custom property with name of "Status" where you want to match value of "Coming Soon" the parameter should be formatted as "cpstatus=Coming Soon&".
file
boolean
optional
Set to “true” if you want to get the data as a file.
Comments