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.

• scheduleId (int, required)

schedule Id to be cancelled (introduced -and kept for compatability in MiViewTV Phase I; superseded by recordingScheduleId)

• programId (int, required)

Live Program ID

• channelId (int, required)

Live Channel ID (EPGLiveChannelReferenceId; as appearing in EPG file)

• seriesId (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))

Whether cancel operation affects a whole series scheduling or not

• recordingScheduleId (string, optional (declared "optional" for backwards compatibility; but needed for correct operation))

ID (string) of the Recording Schedule to be canceled

• 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,

[ 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
2.4 drop 1	Added support for Mirada and Mediaroom. Introduced new parameters recordingScheduleId and targetDeviceId

See also

• RecordingSchedule object type
• Network_Pvr_Service methods