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...") |
|||
| (5 intermediate revisions by 2 users 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 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. |
|Parameters= | |Parameters= | ||
| Line 8: | Line 8: | ||
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=A valid token for identifying the API session context and logged user. | |ParamDescription=A valid token for identifying the API session context and logged user. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 32: | Line 20: | ||
|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) | ||
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object with | + | Returns a JSON object with an array list of [[EpgLiveSchedule]]. |
'''Example:''' | '''Example:''' | ||
{ | { | ||
| − | |||
| − | |||
| − | |||
: [ Array of [[EpgLiveSchedule]] objects ] | : [ Array of [[EpgLiveSchedule]] objects ] | ||
} | } | ||
| Line 66: | Line 63: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.2 | ||
| + | {{!}} Included parameters for program_type and highlights filtering; No longer a paginated list, just an array | ||
| + | {{!}} Francisco Milargo | ||
{{!}}} | {{!}}} | ||
Latest revision as of 13:15, 14 October 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.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- 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)
Returns
Returns a JSON object with an array list of EpgLiveSchedule.
Example:
{
- [ 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 program_type and highlights filtering; No longer a paginated list, just an array | Francisco Milargo |
See also
- EpgLiveProgram object type
- EpgLiveSchedule object type
- Epg Service methods
