CancelRecordingSchedule

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

• channelId (int, required)

Live Channel ID

• 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

• AuthenticationRequiredException: if authentication parameters are incorrect/missing.
• MissingRequiredParameter: if a required parameter is missing.
• InvalidLiveProgramException: if the program id is invalid.
• 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

• RecordingSchedule object type
• Network_Pvr_Service methods