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 ("parent recording schedule" or "recording definition") and delete removes them from the platform.
Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters.
|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=string
|ParamRequired=optional (declared "optional" for backwards compatibility; but needed for correct operation)
|ParamDescription=ID (string) of the Recording Schedule . In rPVR, TO cancel, delete or read a recording, the recordingId sent by OTT devices has to be canceledthe same as recordingId sent by STB IPTV, for consistency.
}}
{{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:* 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=
{{!}} 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
{{!}}}
