CancelRecordingSchedule

Description

Cancel each of the given RecordingSchedule ("parent recording schedule" or "recording definition") and removes them from the platform.

Returns an array of RecordingSchedule objects, filled with the recording related 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:

• The Mediaroom API (RemoveRecordingDefinition) method removes a recording definition (the equivalent concept to a RecordingSchedule), and all associated upcoming recordings, from an account's schedule.​ The behavior of the method depends on whether there are recordings already associated with this recording definition:

• If there are no recordings associated with this definition (there are no matching programs in the current EPG data), the recording definition is deleted.
• If recordings have already been made, the existing recordings are kept, but the recording definition's state is set to "cancelled," preventing any future recordings from being made. After all existing recordings have been deleted, the recording definition is automatically deleted.
• If a recording is currently in progress, it is halted. The recording definition's state is also set to "cancelled," preventing future recordings from being made. Again, after all existing recordings have been deleted, the recording definition is automatically deleted.

• In the RecordingSchedule object handled by GVP (returned to clients), the status would be set to the state "Cancelled" ​(as this state includes both "cancelled" and "deleted" schedules that will be the states managed by Mediaroom when invoking RemoveRecordingDefinition)

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

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

Date-time of 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 MiViewTv, Mirada
• 224 RecordingProgramAlreadyFinished MiViewTv
• 226 RecordingNotAllowedToCancel MiViewTv
• 227 RecordingSeriesNotOwnedBySubscriber 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