Difference between revisions of "SetUserRecordingPin"
Jump to navigation
Jump to search
| Line 22: | Line 22: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=EPGLiveChannelReferenceId |
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=Live Channel ID | + | |ParamDescription=Live Channel ID (as appearing in EPG file) |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 60: | Line 60: | ||
|Exceptions= | |Exceptions= | ||
| − | * | + | * None. |
| − | |||
| − | |||
| − | |||
|Cache= | |Cache= | ||
Revision as of 06:55, 19 September 2014
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
- token (String, required)
- A valid token for identifying the API session context and logged user.
- recordingScheduleId (int, required)
- Recording Schedule ID
- programId (int, required)
- Live Program ID
- EPGLiveChannelReferenceId (int, required)
- Live Channel ID (as appearing in EPG file)
- serieId (int, optional)
- ID of the series associated to the schedule. Value will be set to 0 if the program is not a series episode.
- pin (int, optional)
- Flag to indicate if MTV Parental PIN will be requested when playing the recording. Possible values are: 1 if needed, 0 if not needed.
- entireSeries (bool, optional (default=false))
- 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.
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.4 | Initial method design |
See also
- RecordingSchedule object type
- Network_Pvr_Service methods
