SetUserRecordingPin - Revision history

Id01213 at 09:37, 5 November 2014

2014-11-05T09:37:01Z

Id01213 at 11:28, 31 October 2014

2014-10-31T11:28:17Z

Id01213 at 09:34, 31 October 2014

2014-10-31T09:34:22Z

Id01213 at 08:31, 31 October 2014

2014-10-31T08:31:39Z

Id01213 at 16:24, 19 September 2014

2014-09-19T16:24:48Z

Id01213 at 06:55, 19 September 2014

2014-09-19T06:55:40Z

Id01213 at 07:01, 9 June 2014

2014-06-09T07:01:30Z

Id01213: Created page with "{{Api_Method_Spec| Description= When the user invokes this method for a given recording, ALU MTV platform will request the user to enter its parental PIN when accessing the playb..."

2014-06-02T14:50:59Z

Created page with "{{Api_Method_Spec| Description= When the user invokes this method for a given recording, ALU MTV platform will request the user to enter its parental PIN when accessing the playb..."

New page

{{Api_Method_Spec|
Description= When the user invokes this method for a given recording, ALU MTV platform will request the user to enter its parental PIN when accessing the playback of the recording from its managed STB.

|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
{{Api_Parameter|
ParamName=recordingScheduleId
|ParamType=int
|ParamRequired=required
|ParamDescription=Recording Schedule ID
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Program ID
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Channel ID
}}
{{Api_Parameter|
ParamName=serieId
|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.
}}
{{Api_Parameter|
ParamName=pin
|ParamType=int
|ParamRequired=optional
|ParamDescription=Flag to indicate if MTV Parental PIN will be requested when playing the recording. Possible values are: 1 if needed, 0 if not needed.
}}
{{Api_Parameter|
ParamName=entireSeries
|ParamType=bool
|ParamRequired=optional (default=false)
|ParamDescription=Whether the operation affects all the series or single episode only.
}}

|Returns=
void. Success or error is included as part of the result code in the response.

'''Example:'''

{
: "StatusCode": 0,
: "Severity": 1,
: "StatusMessage": "OK"
}

|Exceptions=
* None.

|Cache=
This method is not cached.

|KnownIssues=
None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 2.4
{{!}} Initial method design
{{!}}
{{!}}}

|SeeAlso=
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}

@@ Line 63: / Line 63: @@
 |Exceptions=
 Possible error results (included in the GVP general error list) are:
 *211	RecordingSubscriberNotFound		''MiViewTv''
 *212	RecordingSubscriberNotSubscribed	''MiViewTv''

@@ Line 62: / Line 62: @@
 |Exceptions=
-* None.
+Possible error results (included in the GVP general error list) are:
 |Cache=

@@ Line 60: / Line 60: @@
 |Exceptions=
-* None.
+* [[StatusCode#AuthenticationRequiredException|AuthenticationRequiredException]]: if authentication parameters are incorrect/missing.
 |Cache=

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
 Description= When the user invokes this method for a given recording, ALU MTV platform will request the user to enter its parental PIN when accessing the playback of the recording from its managed STB.
 |Parameters=

@@ Line 10: / Line 10: @@
 }}
 {{Api_Parameter|
-ParamName=recordingScheduleId
+ParamName=scheduleId
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=Recording Schedule ID
+|ParamDescription=Schedule ID
 }}
 {{Api_Parameter|

@@ Line 22: / Line 22: @@
 }}
 {{Api_Parameter|
-ParamName=EPGLiveChannelReferenceId
+ParamName=channelId
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=Live Channel ID (as appearing in EPG file)
+|ParamDescription=Live Channel ID (EPGLiveChannelReferenceId; as appearing in EPG file)
 }}
 {{Api_Parameter|
-ParamName=serieId
+ParamName=seriesId
 |ParamType=int
 |ParamRequired=optional