SetUserRecordingPin

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:

• 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