Difference between revisions of "SetUserRecordingPin"
Jump to navigation
Jump to search
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{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. | 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. | ||
| + | |||
| + | <p>'''This method only applies to MiViewTV backend (not Mirada and Mediaroom)'''</p> | ||
|Parameters= | |Parameters= | ||
| Line 10: | Line 12: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=scheduleId |
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Schedule ID |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 25: | Line 27: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=Live Channel ID | + | |ParamDescription=Live Channel ID (EPGLiveChannelReferenceId; as appearing in EPG file) |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=seriesId |
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| Line 60: | Line 62: | ||
|Exceptions= | |Exceptions= | ||
| − | * | + | Possible error results (included in the GVP general error list) are: |
| − | * | + | *-2 System.NotSupportedException ''Mirada, Mediaroom'' |
| − | * | + | *211 RecordingSubscriberNotFound ''MiViewTv'' |
| − | + | *212 RecordingSubscriberNotSubscribed ''MiViewTv'' | |
| + | *213 RecordingUnknownError ''MiViewTv'' | ||
| + | *223 RecordingProgramNotFound ''MiViewTv'' | ||
| + | *219 RecordingSeriesNotFound ''MiViewTv'' | ||
|Cache= | |Cache= | ||
Latest revision as of 09:37, 5 November 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.
This method only applies to MiViewTV backend (not Mirada and Mediaroom)
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- scheduleId (int, required)
- Schedule ID
- programId (int, required)
- Live Program ID
- channelId (int, required)
- Live Channel ID (EPGLiveChannelReferenceId; as appearing in EPG file)
- seriesId (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
Possible error results (included in the GVP general error list) are:
- -2 System.NotSupportedException Mirada, Mediaroom
- 211 RecordingSubscriberNotFound MiViewTv
- 212 RecordingSubscriberNotSubscribed MiViewTv
- 213 RecordingUnknownError MiViewTv
- 223 RecordingProgramNotFound MiViewTv
- 219 RecordingSeriesNotFound MiViewTv
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
