REST Pub API: EventTemplateSearch
|StartIndex||The start index of the first item in the payload within the overall result set. Used for paging.|
The number of items returned in the payload in the
|TotalCount||The total number of results in the overall result set. This field is not included unless explicitly requested in the optional parameters.|
|Items||An array of item records.|
|TemplateID||An integer value that uniquely identifies this resource within the platform.|
A string representing the short code used when referring to this template, up to 32 characters long. For example,
|Name||A string representing the name of this event, up to 128 characters long.|
structure containing descriptive information for the template.
An array of structures representing leaf categories associated with this template.
|AdvertisedDuration||A string representing the advertised duration of the template.|
An array of structures representing presenters associated with this template. The order of the records in the array represents the preferred display order of presenters for the template (if there are several).
If the template has no presenters, this field will be omitted.
|Tags||An array of strings representing tags associated with this template. If the template has no tags, this field will be omitted.|
|ViewUri||A string representing a URI where more information for this event can be found. This may be an Arlo page, or it may be a custom URI specified by the event organizer.|
|FieldName||The name of the field. For example,
|Content|| A structure containing marked-up text representing the text content of this field.
Returns a collection of templates matching the search parameters specified.
String representing the required response format. Only required if an
NOTE: If this parameter is missing and no valid
The script function to call with response data
if this call is to be executed as a
A list of comma-separated values representing the required fields for each record in the response payload. Supported values (field names) are listed in the Resource fields section. Field names are not case sensitive. Default is
|filter||A list of comma-separated filters according to the filter specification for this resource.|
|facets||A list of comma-separated facet requests according to the facet specification for this resource.|
A list of comma-separated filters according to the filter specification for this resource that are to be applied during facet generation.
This query parameter is specific to facet generation and is independent of the general
The number of records to skip in the source results before returning the response payload. Used for paging. Default is
The maximum number of records to return in the response payload. Used for paging. Default is
Boolean value determining whether an additional property (
String representing the region to use when retrieving template information. Used only in platforms that have multiple regions installed. This value influences which templates are returned, and which currencies and tax rates are used when computing available offers for that region.
Supported values are dependent on regions installed on the platform. If not specified, the default region for the platform will be used when evaluating the request.
This resource supports use of filters specified using the
filter query parameter. Multiple filters are supported and must be separated by commas.
See EventTemplateSearch filters for a list of available filter codes and their specification.
This resource supports the generation of facets that can be included in the result payload.
See EventTemplateSearch facets for a list of available facet codes and their specification.