/schedules
- Mount Point: /resource/rest/schedules
The following operations are supported on this resource:
GET
- Aliases: POST
Get schedule events for a specific region. This API can be used to retrieve schedule events for the whole line-up or for specificchannels/stations.Note: this API might use caching configured in web.xml.
Parameters
name | description | type | default |
---|---|---|---|
regionId | EPG Region identifier. Required. | query | |
startTime | Date-time in UTC. Required. Following formats are acceptable:
|
query | |
duration | Event duration in minutes. Defaults to 60 minutes. | query | 60 |
start | 0-N - defaults to 0. Pagination by time slots. | query | 0 |
count | 1-N - defaults to MAX_COUNT. Pagination by time slots. | query | |
filters | Optional filters. Expected in the following format: field_name:operator:term,field_name:operator:term... | query | |
formatCode | Code of format in which result should be shown. | query | |
locale | Locale to search and return data for. If not specified, default locale is used from configuration. | query |
Output Payload
element | produceable content type(s) |
---|---|
(custom) |
|
description | |
Schedule events meeting specified criteria in requested format. |
Exceptions
name | description |
---|---|
RESTWebserviceException | if exception occurs. |