EventQuery

Filter parameters to fetch a list of events

Fields

FieldDescription
context

Restrict the event information to a specific context.

Currently allows you to filter the event information (both the events and the pricing information within each event) to a specific saleschannel. This makes it very easy to show the correct information on a website.

Example value:{ "saleschannelid": 3 }
filter
string

A SQL query that returns event IDs

Can be used to do arbitrary filtering. See the database documentation for event for more information.

Example value:"select id from tm.event where locationid=1"
lastupdatesince
timestamp

Only include events that have been updated since the given timestamp.

Example value:"2014-09-26 15:24:36"
limit
int

Limit results to at most the given amount of events.

Example value:100
offset
int

Skip the first X events.

Example value:100
orderby
string

Order by the given field.

Supported values: name, startts.

Example value:"name"
output
string

Output format.

Possible values:

  • ids: Only fill the ID field
  • default: Return all event fields (also used when the output parameter is omitted)
  • withlookup: Returns all event fields and an additional lookup field which contains all dependent objects
Example value:"withlookup"
searchterm
string

A text filter string.

Matches against the start of the event name, the production name or the subtitle.

Example value:"Live"
simplefilter

Filters the events based on a given set of fields. Currently supports: productionid, status and pricetypeids.

Example value:{ "productionid": 4 }

Example

 1{
 2    "context": {
 3        "saleschannelid": 3
 4    },
 5    "filter": "select id from tm.event where locationid=1",
 6    "lastupdatesince": "2014-09-26 15:24:36",
 7    "limit": 100,
 8    "offset": 100,
 9    "orderby": "name",
10    "output": "withlookup",
11    "searchterm": "Live",
12    "simplefilter": {
13        "productionid": 4
14    }
15}