CancelRecordingSchedule - Revision history

Rmc352 at 10:55, 18 February 2021

2021-02-18T10:55:12Z

Rmc352 at 10:00, 18 February 2021

2021-02-18T10:00:51Z

Id02224 at 09:31, 18 February 2021

2021-02-18T09:31:56Z

Id02660 at 11:30, 30 May 2019

2019-05-30T11:30:26Z

Id02660 at 11:24, 30 May 2019

2019-05-30T11:24:44Z

Id02660 at 10:53, 8 April 2019

2019-04-08T10:53:18Z

Id02660 at 10:53, 5 April 2019

2019-04-05T10:53:41Z

Id02660 at 10:27, 5 April 2019

2019-04-05T10:27:13Z

Id01213 at 08:30, 10 December 2014

2014-12-10T08:30:41Z

Id01213 at 10:17, 5 November 2014

2014-11-05T10:17:22Z

@@ Line 66: / Line 66: @@
 |ParamType=string
 |ParamRequired=optional (declared "optional" for backwards compatibility; but needed for correct operation)
-|ParamDescription=ID of the Recording Schedule to be canceled
+|ParamDescription=ID of the Recording Schedule. In rPVR, TO cancel, delete or read a recording, the recordingId sent by OTT devices has to be the same as recordingId sent by STB IPTV, for consistency.
 }}
 {{Api_Parameter|

@@ Line 64: / Line 64: @@
 {{Api_Parameter|
 ParamName=recordingScheduleId
-|ParamType=int
+|ParamType=string
 |ParamRequired=optional (declared "optional" for backwards compatibility; but needed for correct operation)
 |ParamDescription=ID of the Recording Schedule to be canceled

@@ Line 64: / Line 64: @@
 {{Api_Parameter|
 ParamName=recordingScheduleId
-|ParamType=string
+|ParamType=int
 |ParamRequired=optional (declared "optional" for backwards compatibility; but needed for correct operation)
-|ParamDescription=ID (string) of the Recording Schedule to be canceled
+|ParamDescription=ID of the Recording Schedule to be canceled
 }}
 {{Api_Parameter|

@@ Line 96: / Line 96: @@
 :    "Limit": 10,
 :    "Count": 48,
-:    "Content": [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
+:    "List": [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
+}

@@ Line 96: / Line 96: @@
 :    "Limit": 10,
 :    "Count": 48,
-:     [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
+:    "Content": [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
+}

@@ Line 42: / Line 42: @@
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=Live Channel ID (EPGLiveChannelReferenceId; as appearing in EPG file)
+|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|

@@ Line 108: / Line 108: @@
 *235	RequestedLanguagesUnavailable		''Mirada''
 *236	RecordingUpdatedFromAnotherDevice	''Mirada''
-*237	RecordingProtected			''Mirada''
+*237	RecordingProtected			''OpenPlatf, Mirada''
 *238	RecordingHavingChildren			''Mirada''
 *239	RecordingNotFound			''OpenPlatf, Mirada, Mediaroom''

@@ Line 73: / Line 73: @@
 |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)
 }}
@@ Line 90: / Line 96: @@
 |Exceptions=
 Possible error results (included in the GVP general error list) are:
-*8	MissingRequiredParameter		''Mirada''
+*8	MissingRequiredParameter		''OpenPlatf, Mirada''
-*211	RecordingSubscriberNotFound		''MiViewTv, Mirada, Mediaroom''
+*211	RecordingSubscriberNotFound		''OpenPlatf, MiViewTv, Mirada, Mediaroom''
-*212	RecordingSubscriberNotSubscribed	''MiViewTv, Mirada, Mediaorom''
+*212	RecordingSubscriberNotSubscribed	''OpenPlatf, MiViewTv, Mirada, Mediaorom''
-*213	RecordingUnknownError			''MiViewTv, Mirada, Mediaroom''
+*213	RecordingUnknownError			''OpenPlatf, MiViewTv, Mirada, Mediaroom''
-*220	RecordingChannelNotFound		''Mirada''
+*220	RecordingChannelNotFound		''OpenPlatf, Mirada''
-*221	RecordingAlreadySubscribed		''Mirada''
+*221	RecordingAlreadySubscribed		''OpenPlatf, Mirada''
-*223	RecordingProgramNotFound		''MiViewTv, Mirada''
+*223	RecordingProgramNotFound		''OpenPlatf, MiViewTv, Mirada''
-*224	RecordingProgramAlreadyFinished		''MiViewTv''
+*224	RecordingProgramAlreadyFinished		''OpenPlatf, MiViewTv''
-*226	RecordingNotAllowedToCancel		''MiViewTv''
+*226	RecordingNotAllowedToCancel		''OpenPlatf, MiViewTv''
-*227	RecordingSeriesNotOwnedBySubscriber	''MiViewTv''
+*227	RecordingSeriesNotOwnedBySubscriber	''OpenPlatf, MiViewTv''
 *235	RequestedLanguagesUnavailable		''Mirada''
 *236	RecordingUpdatedFromAnotherDevice	''Mirada''
 *237	RecordingProtected			''Mirada''
 *238	RecordingHavingChildren			''Mirada''
-*239	RecordingNotFound			''Mirada, Mediaroom''
+*239	RecordingNotFound			''OpenPlatf, Mirada, Mediaroom''
 *240	RecordingRemoteManagementNotEnabled	''Mirada''
 *241	RecordingIncorrectIntervalDefined	''Mirada''
@@ Line 129: / Line 135: @@
 {{!}} Added support for Mirada and Mediaroom. Introduced new parameters recordingScheduleId, lastModified and targetDeviceId
 {{!}}
 {{!}}}

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description= Cancel each of the given RecordingSchedule and delete them from the platform.
+Description= Cancel each of the given RecordingSchedule ("parent recording schedule" or "recording definition") and removes them from the platform.
 Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters.