Difference between revisions of "GetAllRecordingSchedules"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= Get a list with all the Schedules (as | + | Description= Get a list with all the Schedules (as a paginatedList of [[RecordingSchedule|RecordingSchedule]] objects) for the current user with a given Recording State. |
|Parameters= | |Parameters= | ||
| Line 38: | Line 38: | ||
: "Limit": 10, | : "Limit": 10, | ||
: "Count": 48, | : "Count": 48, | ||
| − | : [ | + | : [ paginatedList of [[RecordingSchedule|RecordingSchedule]] objects ] |
} | } | ||
|Exceptions= | |Exceptions= | ||
| − | * | + | * None. |
| − | |||
| − | |||
|Cache= | |Cache= | ||
Revision as of 06:54, 19 September 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
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
