Bureaucrats, editor
349
edits
Changes
Jump to navigation
Jump to search
no edit summary
{{Api_Method_Spec|
Description= Deletes the provided Recording Schedule (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|RecordingSchedule]] objects, filled with the results and status parameters.
<p>* '''MiView (ALU) comments''':</p>
* MiView does not establish a clear distinction between RecordingSchedules and Recordings.
* In MiView, since it is a true "network PVR" model, recordings are stored "in the network" (not in the user's STB).
* DeleteRecordingSchedule, when invoked for a MiView backend, deletes (or cancels) the recording (schedules), so subsequent requests for listing the user's "recordings" result in that the recordings/RecordingSchedules do not appear. "Physical" recordings do not make sense in this case, as they are stored and handled by MiView platform (so, although a user removes a recording, the media may be kept to be used by another user).
<p>* '''Mirada comments''':</p>
<p>* '''Mediaroom comments''':</p>
* The Mediaroom API DeleteRecordingSchedules is '''intended for deleting individual (RemoveRecordingDefinition) method removes a recording definition (the equivalent concept to a [[RecordingSchedule|RecordingSchedule]]"child"), and all associated upcoming recordings, from an accountexisting in the user's scheduleSTB''', but not cancelling or deleting the whole definition (RecordingDefinition). The behavior * Clients must invoke DeleteRecordingSchedule sending the id of the method depends on whether there are recordings already associated with this recording definition:<ul> <li>If there are no recordings associated with this definition Recording (there are no matching programs not RecordingDefinition in the current EPG datacase of Mediaroom), to delete within the recording definition is deletedrecordingScheduleId.</li> <li>If several recordings must be deleted, client will have already been made, to request it through sequential requests (one by one)* Since the behavior of DeleteRecordingSchedule in Mediaroom is "to remove the existing completed recordings are kept, but on the recording definition's state is set to STB"cancelled," preventing any future recordings from being made. After all existing recordings have been deleted, it does not make sense to request the recording definition is automatically deleted.</li> <li>If deletion of a recording is currently in progresswhole series, so '''method will return an error if it is halted. The recording definitioninvoked requesting an entireSeries deletion in Mediaroom'''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.</li></ul>* In the [[RecordingSchedule|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)
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Channel ID (EPGLiveChannelReferenceIdGVP_EPG_LIVE_CHANNELS.REFERENCE_ID; as appearing in EPG file) available in contentApi (LSC.EpgChannelId) info not available in IPI, sent blank in that case}}{{Api_Parameter|ParamName=LiveChannelId|ParamType=int|ParamRequired=required|ParamDescription= GVP Live Channel ID (GVP_EPG_SCHEDULE. EPG_LIVE_CHANNEL_ID) the ChannelId sent through contentApi (LSC.ChannelId) and IPI (Channel_id: ServiceName)
}}
{{Api_Parameter|
|ParamType=int
|ParamRequired=optional
|ParamDescription=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.
}}
{{Api_Parameter|
|ParamType=string
|ParamRequired=optional (declared "optional" for backwards compatibility; but needed for correct operation)
|ParamDescription=ID (string) of the Recording Schedule to be deleted
}}
{{Api_Parameter|
|ParamRequired=optional
|ParamDescription=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)
}}
{{Api_Parameter|
ParamName=SeasonNumber
|ParamType=int
|ParamRequired=optional
|ParamDescription=This parameter is mandatory in OpenPlatform implementation, is the SeasonNumber of the LSC object in contentApi (BBDD GVP_EPG_PROGRAMS.EPG_SEASON_NUMBER)
}}
: "Limit": 10,
: "Count": 48,
: "List":[ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
}
|Exceptions=
Possible error results (included in the GVP general error list) are:
*8 MissingRequiredParameter ''OpenPlatf, Mirada''*211 RecordingSubscriberNotFound ''OpenPlatf, MiViewTv, Mirada, Mediaroom''*212 RecordingSubscriberNotSubscribed ''OpenPlatf, MiViewTv, Mirada, Mediaorom''*213 RecordingUnknownError ''OpenPlatf, MiViewTv, Mirada, Mediaroom''*220 RecordingChannelNotFound ''OpenPlatf, Mirada''*221 RecordingAlreadySubscribed ''OpenPlatf, Mirada''*223 RecordingProgramNotfound ''OpenPlatf, Mirada''*228 RecordingProgramNotFinished ''OpenPlatf, MiViewTv''*235 RequestedLanguagesUnavailable ''OpenPlatf, Mirada''*236 RecordingUpdatedFromAnotherDevice ''OpenPlatf, Mirada''*237 RecordingProtected ''OpenPlatf, Mirada''*238 RecordingHavingChildren ''OpenPlatf, Mirada''*239 RecordingNotFound ''OpenPlatf, Mirada, Mediaroom''*240 RecordingRemoteManagementNotEnabled ''OpenPlatf, Mirada''
*241 RecordingIncorrectIntervalDefined ''Mirada''
*242 RecordingIncorrectStartDate ''Mirada''
{{!}} Added support for Mirada and Mediaroom. Introduced new parameters recordingScheduleId, lastModified and targetDeviceId
{{!}}
{{!}}- valign="top"
! 3.0
{{!}} Changed behavior for Mediaroom: method deletes completed (child) Recordings, not RecordingDefinitions
{{!}}
{{!}}- valign="top"
! 7.1
{{!}} Changed behavior for OpenPlatform. SeasonNumber
{{!}} José Manuel Escartín
{{!}}}
