Difference between revisions of "GetLiveChannelPrograms"
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...") |
|||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[GetLiveChannelsReducedLiveSchedules]] or [[GetDetailedLiveChannelsSchedules]] instead}} | ||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Returns the list of live programs (as array of [[EpgLiveProgram]] objects) for the provided channel ID and time frame. | Description=Returns the list of live programs (as array of [[EpgLiveProgram]] objects) for the provided channel ID and time frame. | ||
| Line 73: | Line 75: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- | ||
| + | ! 3.2 | ||
| + | {{!}} Method deprecated | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
| Line 78: | Line 84: | ||
* [[EpgLiveProgram]] object type | * [[EpgLiveProgram]] object type | ||
* [[EpgLiveSchedule]] object type | * [[EpgLiveSchedule]] object type | ||
| + | * [[GetLiveChannelsReducedLiveSchedules]] | ||
| + | * [[GetDetailedLiveChannelsSchedules]] | ||
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods | * [[UNIAPI_Specification#Epg_Service| Epg Service]] methods | ||
}} | }} | ||
Latest revision as of 06:52, 21 August 2015
This method has been deprecated in GVP 3.2. Please use GetLiveChannelsReducedLiveSchedules or GetDetailedLiveChannelsSchedules instead
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 |
| 3.2 | Method deprecated | Francisco Milagro |
See also
- EpgLiveProgram object type
- EpgLiveSchedule object type
- GetLiveChannelsReducedLiveSchedules
- GetDetailedLiveChannelsSchedules
- Epg Service methods
