Arlo

REST Pub API: EventTemplateSearch filters

The EventTemplateSearch resource supports filtering of the resultset via the filter query parameter. Filters are specified using the format filter_code=filter_parameter. Multiple filters can be used in a single request and must be separated by commas in the query.

Care must be taken to ensure that all string parameter values are encoded for filters, particularly those involving user-specified values such as codes and names that may have value with characters that, if not properly encoded, would prevent correct parsing of the filter query.

Filters specification

Category ID (categoryid)

Filters search results based on the categories of templates. Parameter must be an encoded category ID string value, or an array of encoded category ID string values.

Examples

  • Filter results by a single category ID: ?filter=categoryid=683
  • Filter results by a list of category IDs: ?filter=categoryid=[683,684,685]

Template ID (templateid)

Filters search results based on the id of templates. Parameter must be an encoded template ID string value, or an array of encoded template ID string values.

Examples

  • Filter results by a single category ID: ?filter=templateid=683
  • Filter results by a list of category IDs: ?filter=templateid=[683,684,685]

Code (code)

Filters search results based on the code of templates. Parameter must be an encoded template code string value, or an array of encoded code string values.

Examples

  • Filter results by a single code: ?filter=code=MGMT101
  • Filter results by a list of codes: ?filter=code=[MGMT101,MGMT102,MGMT103]

Tag (tag)

Filters search results based on template tag values. Parameter must be an encoded tag string value, or an array of encoded tag string values.

Examples

  • Filter results by a single tag: ?filter=tag=NewIn2013
  • Filter results by a list of tags: ?filter=tag=[NewIn2013,Popular]

Advertised presenter (advertisedpresenterid)

Filters search results based on the ID of the presenters associated with a template. Parameter must be an encoded presenter ID string value, or an array of encoded presenter ID string values.

Examples

  • Filter results by a single presenter ID: ?filter=advertisedpresenterid=199
  • Filter results by a list of presenter IDs: ?filter=advertisedpresenterid=[199,200,201]

Topic code (topiccode)

Filters search results based on the topic of each template. Parameter must be an encoded topic string value, or an array of encoded topic string values.

Examples

  • Filter results by a single code: ?filter=templatetopic=ECON
  • Filter results by a list of codes: ?filter=templatetopic=[MATH,COSC,ECON]