DeleteRecordingSchedule

Description

Delete each of the given Schedule Recording from the platform. If the external platform provides a Network PVR service, this method will remove contents accessible by the network. In the case of Remote PVR service availability, this method will physically delete contents from the connected STB hard disk.

Returns an array of RecordingSchedule objects, filled with the recording related parameters:

• If the recording was successfully deleted by the platform, its state will be "Deleted"
• If a given recording could not be deleted, its state will remain "Recorded".
• If a given recording 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