Difference between revisions of "CancelRecordingSchedule"
Jump to navigation
Jump to search
| Line 27: | Line 27: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=EPGLiveChannelReferenceId |
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=Live Channel ID | + | |ParamDescription=Live Channel ID (as appearing in EPG file) |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 60: | Line 60: | ||
|Exceptions= | |Exceptions= | ||
| − | * | + | * None. |
| − | |||
| − | |||
| − | |||
|Cache= | |Cache= | ||
Revision as of 06:52, 19 September 2014
Description
Cancel each of the given RecordingSchedule and delete them from the platform.
Returns an rray of RecordingSchedule objects, filled with the recording related parameters:
- If the recording schedule was successfully cancelled and deleted by the platform, its state will be "Canceled"
- If a given recording schedule could not be canceled, its state will remain "Scheduled".
- If a given recording schedule was not found, its state will be "Not Found".
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- recordingScheduleId (int, required)
- ID of the Recording Schedule to be canceled
- programId (int, required)
- Live Program ID
- EPGLiveChannelReferenceId (int, required)
- Live Channel ID (as appearing in EPG file)
- serieId (int, optional)
- ID of the series associated to the schedule. Value will be set to 0 if the program is not a series episode.
- entireSeries (bool, optional (default=false))
- If the Schedule Id is a series episode, all the next episodes should also be scheduled for recording when set to true. If set to false, only the single episode will be scheduled.
Returns
Returns a JSON object with a list of RecordingSchedule.
Example:
{
- "Offset": 0,
- "Limit": 10,
- "Count": 48,
- [ Array 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
- RecordingSchedule object type
- Network_Pvr_Service methods
