GetDetailedLivePrograms
Revision as of 15:02, 2 June 2014 by Id02256 (talk | contribs) (Created page with "{{Api_Method_Spec| Description=Returns the list of live programs (as array of EpgLiveProgram objects) for the provided program IDs. |Parameters= {{Api_Parameter| ParamName=t...")
Description
Returns the list of live programs (as array of EpgLiveProgram objects) for the provided program IDs.
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
- liveProgramIds (array of int, required)
- List of live program IDs
Returns
Returns a JSON object with a list of EpgLiveProgram.
Example:
{
- "Offset": 0,
- "Limit": 10,
- "Count": 48,
- [ Array of EpgLiveProgram objects ]
}
Exceptions
- InvalidLiveProgramException: if program ID does not exist.
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
- EpgLiveProgram object type
- EpgLiveSchedule object type
- Epg Service methods