Difference between revisions of "GetAllRecordingSchedules"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= Get a list with all the Schedules (as an array of RecordingSchedule objects) for the current user with a given Recording Sta...") |
|||
| Line 43: | Line 43: | ||
|Exceptions= | |Exceptions= | ||
| − | * | + | * [[StatusCode#AuthenticationRequiredException|AuthenticationRequiredException]]: if authentication parameters are incorrect/missing. |
| + | * [[StatusCode#InvalidParameterValueException|InvalidParameterValueException]]: invalid parameter in the request. | ||
| + | * [[StatusCode#UnexpectedRecordingResponseException|UnexpectedRecordingResponseException]]: General recording service exception. | ||
|Cache= | |Cache= | ||
Revision as of 06:59, 9 June 2014
Description
Get a list with all the Schedules (as an array 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,
- [ Array of RecordingSchedule objects ]
}
Exceptions
- AuthenticationRequiredException: if authentication parameters are incorrect/missing.
- InvalidParameterValueException: invalid parameter in the request.
- UnexpectedRecordingResponseException: General recording service exception.
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
