Difference between revisions of "GetLiveChannelPrograms"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of live programs (as array of EpgLiveProgram objects) for the provided channel ID and time frame. |Parameters= {{Api_Paramete...")
(No difference)

Revision as of 15:16, 2 June 2014

Description

Returns the list of live programs (as array of EpgLiveProgram objects) for the provided channel ID and time frame.

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
  • liveChannelId (int, required)
Channel ID
  • startDate (DateTime, required)
starting time period for the query (long int)
  • endDate (DateTime, required)
ending time period for the query (long int)


Returns

Returns a JSON object with a list of EpgLiveProgram.

Example:

{

"Offset": 0,
"Limit": 10,
"Count": 48,
[ Array of EpgLiveProgram 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