Difference between revisions of "GetLiveSchedulesById"
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 list of schedules (IDs) and adult filter. |Parameter...") |
|||
| 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 list of schedules (IDs) and | + | Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided list of schedules (IDs), adult filter and program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents, and to sort the schedule lists by rating value (descending).. |
|Parameters= | |Parameters= | ||
| Line 32: | 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=programTypeFilter | ||
| + | |ParamType=[[ProgramType]] | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Filter results to only include the provided program type (default = all; no filtering) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=highlightsOnlyFilter | ||
| + | |ParamType=bool | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=If true, only "highlighted" contents (rating>0) are returned (default = false) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=highlightsSorting | ||
| + | |ParamType=[[HighlightsSorting]] | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Sorting criteria (default = 0; contents/schedules are not sorted by rating) | ||
}} | }} | ||
| Line 66: | Line 84: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.1 | ||
| + | {{!}} Included parameters for program_type and highlights filtering, and highlights sorting | ||
| + | {{!}} Jose A. Jiménez | ||
{{!}}} | {{!}}} | ||
Revision as of 06:54, 1 April 2015
Description
Returns the list of live schedules (as array of EpgLiveSchedule objects) for the provided list of schedules (IDs), adult filter and program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents, and to sort the schedule lists by rating value (descending)..
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
- liveSchedulesIds (array of int, required)
- List of live schedules to retrieve
- adultFilter (AdultFilterType, optional)
- Adult filter to apply to the list (default = all)
- programTypeFilter (ProgramType, optional)
- Filter results to only include the provided program type (default = all; no filtering)
- highlightsOnlyFilter (bool, optional)
- If true, only "highlighted" contents (rating>0) are returned (default = false)
- highlightsSorting (HighlightsSorting, optional)
- Sorting criteria (default = 0; contents/schedules are not sorted by rating)
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.1 | Included parameters for program_type and highlights filtering, and highlights sorting | Jose A. Jiménez |
See also
- EpgLiveProgram object type
- EpgLiveSchedule object type
- Epg Service methods
