GetLiveProgramSchedulesWithDate

From Gvp-public
Jump to navigation Jump to search

Description

Returns the list of live schedules (as array of EpgLiveSchedule objects) for the provided program ID, adult filter and time frame (DateTime 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)

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
  • startDate (DateTime, required)
Starting time frame (long int)
  • endDate (DateTime, required)
Ending time frame (long int)
Adult filter to apply to the list (default = all)


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


See also