Bureaucrats, editor
48
edits
Changes
Jump to navigation
Jump to search
CancelRecordingSchedule (view source)
Revision as of 10:55, 18 February 2021
, 10:55, 18 February 2021no edit summary
{{Api_Method_Spec|
Description= Cancel each of the given RecordingSchedule and delete them from the platform. Returns an rray of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters:* If the recording schedule was successfully cancelled and deleted by the platform, its state will be ("Canceled"* If a given parent recording schedule could not be canceled, its state will remain "Scheduledor ". * If a given recording schedule was not found, its state will be "Not Founddefinition") and removes them from the platform.
Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters.
<p>* '''Mirada comments''':</p>
* Clients wanting to cancel (or delete) a recording should have to firstly request a [[GetAllRecordingSchedules|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|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|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.
<p>* '''Mediaroom comments''':</p>
* The Mediaroom API (RemoveRecordingDefinition) method removes a recording definition (the equivalent concept to a [[RecordingSchedule|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:
<ul>
<li>If there are no recordings associated with this definition (there are no matching programs in the current EPG data), the recording definition is deleted.</li>
<li>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.</li>
<li>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.</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)
|Parameters=
{{Api_Parameter|
}}
{{Api_Parameter|
ParamName=recordingScheduleIdscheduleId
|ParamType=int
|ParamRequired=required
|ParamDescription=ID of the Recording Schedule schedule Id to be canceledcancelled (introduced -and kept for compatability in MiViewTV Phase I; superseded by recordingScheduleId)
}}
{{Api_Parameter|
}}
{{Api_Parameter|
ParamName=EPGLiveChannelReferenceIdchannelId|ParamType=int|ParamRequired=required|ParamDescription=Live Channel ID (GVP_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 (as appearing in EPG fileGVP_EPG_SCHEDULE. EPG_LIVE_CHANNEL_ID) the ChannelId sent through contentApi (LSC.ChannelId) and IPI (Channel_id: ServiceName)
}}
{{Api_Parameter|
ParamName=serieIdseriesId
|ParamType=int
|ParamRequired=optional
|ParamType=bool
|ParamRequired=optional (default=false)
|ParamDescription=If Whether cancel operation affects a whole series scheduling or not}}{{Api_Parameter|ParamName=recordingScheduleId|ParamType=string|ParamRequired=optional (declared "optional" for backwards compatibility; but needed for correct operation)|ParamDescription=ID of the Recording Schedule Id is . In rPVR, TO cancel, delete or read a series episoderecording, all the next episodes should also recordingId sent by OTT devices has to be scheduled the same as recordingId sent by STB IPTV, for consistency.}}{{Api_Parameter|ParamName=lastModified|ParamType=int|ParamRequired=optional (needed for correct operation in Mirada)|ParamDescription=Date-time of last modification of the recording when set schedule (must be previously obtained from Mirada's backend)}}{{Api_Parameter|ParamName=targetDeviceId|ParamType=int|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 true. If set to falseMiView and Mediaroom)}}{{Api_Parameter|ParamName=SeasonNumber|ParamType=int|ParamRequired=optional|ParamDescription=This parameter is mandatory in OpenPlatform implementation, only is the single episode will be scheduledSeasonNumber of the LSC object in contentApi (BBDD GVP_EPG_PROGRAMS.EPG_SEASON_NUMBER)
}}
|Returns=
: "Limit": 10,
: "Count": 48,
: "List": [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
}
|Exceptions=
Possible error results (included in the GVP general error list) are:* None.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, MiViewTv, Mirada''*224 RecordingProgramAlreadyFinished ''OpenPlatf, MiViewTv''*226 RecordingNotAllowedToCancel ''OpenPlatf, MiViewTv''*227 RecordingSeriesNotOwnedBySubscriber ''OpenPlatf, MiViewTv''*235 RequestedLanguagesUnavailable ''Mirada''*236 RecordingUpdatedFromAnotherDevice ''Mirada''*237 RecordingProtected ''OpenPlatf, Mirada''*238 RecordingHavingChildren ''Mirada''*239 RecordingNotFound ''OpenPlatf, Mirada, Mediaroom''*240 RecordingRemoteManagementNotEnabled ''Mirada''*241 RecordingIncorrectIntervalDefined ''Mirada''*242 RecordingIncorrectStartDate ''Mirada''
|Cache=
{{!}} Initial method design
{{!}}
{{!}}- valign="top"
! 2.4 drop 1
{{!}} Added support for Mirada and Mediaroom. Introduced new parameters recordingScheduleId, lastModified and targetDeviceId
{{!}}
{{!}}- valign="top"
! 7.1
{{!}} Added support to OpenPlatform. SeasonNumber
{{!}} José Manuel Escartín
{{!}}}
