GetLiveSchedulesById

From Gvp-public
Revision as of 13:15, 14 October 2015 by Id01213 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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
Adult filter to apply to the list (default = all)
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