Difference between revisions of "GetLiveProgramSchedules"
Jump to navigation
Jump to search
| 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, adult filter and program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents | + | Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided program ID, 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 44: | Line 44: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=If true, only "highlighted" contents (rating>0) are returned (default = false) | |ParamDescription=If true, only "highlighted" contents (rating>0) are returned (default = false) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
| Line 86: | Line 80: | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! 3.1 | ! 3.1 | ||
| − | {{!}} Included parameters for program_type and highlights filtering | + | {{!}} Included parameters for program_type and highlights filtering |
{{!}} Jose A. Jiménez | {{!}} Jose A. Jiménez | ||
{{!}}} | {{!}}} | ||
Revision as of 14:06, 20 April 2015
Description
Returns the list of live schedules (as array of EpgLiveSchedule objects) for the provided program ID, 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.
- 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)
- 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 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 | Jose A. Jiménez |
See also
- EpgLiveProgram object type
- EpgLiveSchedule object type
- Epg Service methods
