Difference between revisions of "GetRecordingSchedule"
Jump to navigation
Jump to search
| Line 10: | Line 10: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=recordingScheduleId |
| − | |ParamType= | + | |ParamType=string |
| − | |ParamRequired= | + | |ParamRequired=required |
| − | |ParamDescription= | + | |ParamDescription=ID (string) of the Recording Schedule to retrieve info |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
Revision as of 08:24, 31 October 2014
Description
Gets info on a specific recording schedule (returned as a RecordingSchedule object). The Id of the recording schedule to be retrieved is provided as an input parameter.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- recordingScheduleId (string, required)
- ID (string) of the Recording Schedule to retrieve info
- 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 RecordingSchedule object.
Example:
{
- RecordingSchedule object
}
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
- GetAllRecordingSchedule method
- Network_Pvr_Service methods
