AddRecordingSchedule

Description

Allows scheduling a personal recording for a single event or for a complete series.

Returns an array of RecordingSchedule objects, filled according to these conditions:

If the recording of the schedule causes a conflict, it won't be scheduled and the state of the returned object will be "Conflicted". StatusCode will be “Recording Service Error Due To Conflicted Record”. This error code is one of the possible error codes returned returned by the method.

• If recordEntireSeries is false, returns the only recording schedule
• If recordEntireSeries is true and there is only one occurrence (episode) of the series, return this recording schedule
• If recordEntireSeries is true and there are multiple episodes, return the recording schedules of all episodes

Parameters

• token (String, required)

A valid token for identifying the API session context and logged user.

• scheduleId (int, required)

Live 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.

• entireSeries (bool, optional (default=false))

If the Schedule Id is a series episode, all the next episodes should also be scheduled for recording when set to true. If set to false, only the single episode will be scheduled.

• targetDeviceId (int, optional)

Allows identifying the user's device (STB) on which the application will be applied, in the case that several DVR devices may exist in the household (does not apply to MiView and Mediaroom)

Returns

Returns a JSON object with a list of RecordingSchedule.

Example:

{

"Offset": 0,

"Limit": 10,

"Count": 48,

[ Array of RecordingSchedule objects ]

}

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
2.4 drop 1	Added support for Mirada and Mediaroom. Introduced new parameter targetDeviceId

See also

• RecordingSchedule object type
• Network_Pvr_Service methods