editor
278
edits
Changes
Jump to navigation
Jump to search
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..."
{{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
}}
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
}}
