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 a paginatedList of [[RecordingSchedule|RecordingSchedule]] objects) for the current user with a given Recording State. | Description= Get a list with all the Schedules (as a paginatedList of [[RecordingSchedule|RecordingSchedule]] objects) for the current user with a given Recording State. | ||
| + | |||
| + | <p>In the case of series/recurrent recording schedules, the method also returns the individual recordings (not only the recordingschedule/RecordingDefinition/"parent" recording), due to backwards compatibility reasons and because of client (Go app) requirements:</p> | ||
| + | <p>Client apps need to know the individual recordings in order to show them graphically to the user ("drawing"/marking all the precise episodes that will be recorded in a series recording, etc.). Recordings created as "series recording" are marked (as "series" type) and associated with the corresponding seriesId (and rest of relevant fields such as the scheduleId, programId, etc.)</p> | ||
| + | |||
| + | <p>* '''Mirada comments''':</p> | ||
| + | * Clients should store the lastModified parameter included in the [[RecordingSchedule|RecordingSchedule]] object(s), as future invocations to cancel/delete recordings methods will require submitting the "lastModified" value in the request. When a client wants to request a cancel/delete, it will need first to retrieve the information (via GetAllRecordingSchedules). | ||
| + | * In Mirada, when creating a "series recording schedule", UNIAPI only creates the "containter"/parent recording, and the STB will add all the associated episodes automatically (as a recording "Linked" to a parent recording). When retrieving the list of recordings from Mirada, "child" recordings will have a reference to their parent (series recording schedule), properly filled in the corresponding fields of the [[RecordingSchedule|RecordingSchedule]] object. | ||
| + | |||
|Parameters= | |Parameters= | ||
Revision as of 09:22, 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.
In the case of series/recurrent recording schedules, the method also returns the individual recordings (not only the recordingschedule/RecordingDefinition/"parent" recording), due to backwards compatibility reasons and because of client (Go app) requirements:
Client apps need to know the individual recordings in order to show them graphically to the user ("drawing"/marking all the precise episodes that will be recorded in a series recording, etc.). Recordings created as "series recording" are marked (as "series" type) and associated with the corresponding seriesId (and rest of relevant fields such as the scheduleId, programId, etc.)
* Mirada comments:
- Clients should store the lastModified parameter included in the RecordingSchedule object(s), as future invocations to cancel/delete recordings methods will require submitting the "lastModified" value in the request. When a client wants to request a cancel/delete, it will need first to retrieve the information (via GetAllRecordingSchedules).
- In Mirada, when creating a "series recording schedule", UNIAPI only creates the "containter"/parent recording, and the STB will add all the associated episodes automatically (as a recording "Linked" to a parent recording). When retrieving the list of recordings from Mirada, "child" recordings will have a reference to their parent (series recording schedule), properly filled in the corresponding fields of the RecordingSchedule object.
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 | |
| 2.4 drop 1 | Added support for Mirada and Mediaroom. Introduced new parameter targetDeviceId |
See also
- RecordingScheduleState enum
- RecordingSchedule object type
- Network_Pvr_Service methods
