Difference between revisions of "GetAllRecordingSchedules"
Jump to navigation
Jump to search
| Line 27: | Line 27: | ||
|ParamDescription=Recording schedule state to filter results | |ParamDescription=Recording schedule state to filter results | ||
}} | }} | ||
| − | + | {{Api_Parameter| | |
| + | ParamName=targetDeviceId | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Allows identifying the user's device (STB) on which the application will be applied, in the case that several DVR devices may exist in the household (does not apply to MiView and Mediaroom) | ||
| + | }} | ||
|Returns= | |Returns= | ||
Revision as of 08:14, 31 October 2014
Description
Get a list with all the Schedules (as a paginatedList of RecordingSchedule objects) for the current user with a given Recording State.
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
- GvpRecordingState (RecordingScheduleState enum, optional)
- Recording schedule state to filter results
- targetDeviceId (int, optional)
- Allows identifying the user's device (STB) on which the application will be applied, in the case that several DVR devices may exist in the household (does not apply to MiView and Mediaroom)
Returns
Returns a JSON object with a list of RecordingSchedule.
Example:
{
- "Offset": 0,
- "Limit": 10,
- "Count": 48,
- [ paginatedList of RecordingSchedule objects ]
}
Exceptions
- None.
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.4 | Initial method design |
See also
- RecordingScheduleState enum
- RecordingSchedule object type
- Network_Pvr_Service methods
