/programschedule
- Mount Point: /resource/rest/programschedule
The following operations are supported on this resource:
GET
- Aliases: POST
Get schedule events for a specific region and program. This API can be used to retrieve schedule events for the whole line-up.Note: this API might use caching configured in web.xml.
Parameters
name | description | type | default |
---|---|---|---|
regionId | EPG Region identifier. Required. | query | |
programId | EPG Program externalId. Required. | query | |
startTime | Date-time in UTC. Required. Following formats are acceptable:
|
query | |
duration | Event duration in minutes. Defaults to 10080 minutes (7 days). | query | 10080 |
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. |