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.

• scheduleId (int, required)

schedule Id to be deleted (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 delete 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 deleted

• 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