Difference between revisions of "GetLiveProgramSchedules"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of live schedules (as array of EpgLiveSchedule objects) for the provided program ID and adult filter. |Parameters= {{Api_Par...") |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided program ID and adult filter. | + | Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided program ID, and adult filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents. |
| − | |||
|Parameters= | |Parameters= | ||
| Line 33: | Line 32: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Adult filter to apply to the list (default = all) | |ParamDescription=Adult filter to apply to the list (default = all) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=highlightsOnlyFilter | ||
| + | |ParamType=bool | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=If true, only "highlighted" contents (rating>0) are returned (default = false) | ||
}} | }} | ||
| Line 67: | Line 72: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.2 | ||
| + | {{!}} Included parameters for highlights filtering | ||
| + | {{!}} Jose A. Jiménez | ||
{{!}}} | {{!}}} | ||
Latest revision as of 13:15, 14 October 2015
Description
Returns the list of live schedules (as array of EpgLiveSchedule objects) for the provided program ID, and adult filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- offset (int, optional)
- Index of the initial result of the list, begins with 0
- limit (int, optional)
- Quantity of results showed, with the maximum of 100
- liveProgramId (int, required)
- Program ID
- adultFilter (AdultFilterType, optional)
- Adult filter to apply to the list (default = all)
- highlightsOnlyFilter (bool, optional)
- If true, only "highlighted" contents (rating>0) are returned (default = false)
Returns
Returns a JSON object with a list of EpgLiveSchedule.
Example:
{
- "Offset": 0,
- "Limit": 10,
- "Count": 48,
- [ Array of EpgLiveSchedule objects ]
}
Exceptions
- None.
Caching
This method is cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
| 3.2 | Included parameters for highlights filtering | Jose A. Jiménez |
See also
- EpgLiveProgram object type
- EpgLiveSchedule object type
- Epg Service methods
