GetLiveSchedules
Revision as of 15:21, 2 June 2014 by Id02256 (talk | contribs) (Created page with "{{Api_Method_Spec| Description=Returns the list of live schedules (as array of EpgLiveSchedule objects) for the time frame and adult filter. |Parameters= {{Api_Parameter| Pa...")
Description
Returns the list of live schedules (as array of EpgLiveSchedule objects) for the time frame and adult filter.
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
- startDate (DateTime, required)
- Starting time frame (long int)
- endDate (DateTime, required)
- Ending time frame (long int)
- adultFilter (AdultFilterType, optional)
- 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
- EpgLiveProgram object type
- EpgLiveSchedule object type
- Epg Service methods