GetDetailedLiveChannelsSchedules

From Gvp-public
Revision as of 14:05, 20 April 2015 by Id01213 (talk | contribs)
Jump to navigation Jump to search

Description

Returns the list of detailed schedules (as array of EpgLiveSchedule objects) for the provided channel IDs and time range (DateTime value type represents dates and times measured in 100-nanosecond units called ticks, and a particular date is the number of ticks since 12:00 midnight, January 1, 0001 A.D. (C.E.) in the GregorianCalendar calendar), 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
  • liveChannelIds (array of int, required)
List of live channel IDs
  • startDate (DateTime, required)
Starting time period for the query (as a long int)
  • endDate (DateTime, required)
Ending time period for the query (as a long int)
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