DeleteRecordingSchedule

Description

Deletes the provided Recording (ID). This method is mainly intended for deleting recordings ("child recordings") from the user's STB, although it is also allowed (depending on the backend) to delete RecordingDefinition ("parent recording" or "recording definition") from the platform.

Returns an array of RecordingSchedule objects, filled with the results and status parameters.

* Mirada comments:

• Clients wanting to cancel (or delete) a recording should have to firstly request a GetAllRecordingSchedules call, in order to retrieve the recordings ID and (in the case of Mirada) the associated lastModified value that must be included in the cancel/delete request. ​This parameter will not be available (GetAllRecordingSchedules will return 0) for some other rPVR backends.
• When cancelling things "in the future" (not started yet), such as individual movies/episodes not started yet, or the cancellation of entire series, the final purpose is to "avoid" the future recording of an event. The RecordingSchedule object would be set to GVP status "Cancelled"
• When cancelling only a thing that is just being recorded at the current moment (at the moment of invoking cancel by the client) the final purpose is to "stop" the ongoing recording (and the status of the schedule, in both Mirada's backend and in the RecordingSchedule object returned to clients, would be set to "finished"​/completed, not "cancelled"). This is the case when cancelling individual events or episodes within series (but NOT cancelling the whole series) AND the event to cancel is just being recorded at this moment.

* Mediaroom comments:

DeleteRecordingSchedules is intended for deleting individual ("child") recordings, existing in the user's STB, but not cancelling or deleting the whole definition (RecordingDefinition).

Clients must invoke DeleteRecordingSchedule sending the id of the Recording (not RecordingDefinition in the case of Mediaroom) to delete within the recordingScheduleId. If several recordings must be deleted, client will have to request it through sequential requests (one by one) Since the behavior of DeleteRecordingSchedule in Mediaroom is "to remove the completed recordings on the STB", it does not make sense to request the deletion of a whole series, so method will return an error if it is invoked requesting an entireSeries deletion in Mediaroom.

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. Deletion of series is not allowed in all backends.

• 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 to be deleted

• lastModified (int, optional (needed for correct operation in Mirada))

Date-time of the last modification of the recording schedule (must be previously obtained from Mirada's backend)

• 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

Possible error results (included in the GVP general error list) are:

• 8 MissingRequiredParameter Mirada
• 211 RecordingSubscriberNotFound MiViewTv, Mirada, Mediaroom
• 212 RecordingSubscriberNotSubscribed MiViewTv, Mirada, Mediaorom
• 213 RecordingUnknownError MiViewTv, Mirada, Mediaroom
• 220 RecordingChannelNotFound Mirada
• 221 RecordingAlreadySubscribed Mirada
• 223 RecordingProgramNotfound Mirada
• 228 RecordingProgramNotFinished MiViewTv
• 235 RequestedLanguagesUnavailable Mirada
• 236 RecordingUpdatedFromAnotherDevice Mirada
• 237 RecordingProtected Mirada
• 238 RecordingHavingChildren Mirada
• 239 RecordingNotFound Mirada, Mediaroom
• 240 RecordingRemoteManagementNotEnabled Mirada
• 241 RecordingIncorrectIntervalDefined Mirada
• 242 RecordingIncorrectStartDate Mirada

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, lastModified and targetDeviceId

See also

• RecordingSchedule object type
• Network_Pvr_Service methods