Difference between revisions of "AddRecordingSchedule"
Jump to navigation
Jump to search
| Line 65: | Line 65: | ||
|Exceptions= | |Exceptions= | ||
* [[StatusCode#AuthenticationRequiredException|AuthenticationRequiredException]]: if authentication parameters are incorrect/missing. | * [[StatusCode#AuthenticationRequiredException|AuthenticationRequiredException]]: if authentication parameters are incorrect/missing. | ||
| + | * [[StatusCode#MissingRequiredParameter|MissingRequiredParameter]]: if a required parameter is missing. | ||
| + | * [[StatusCode#InvalidLiveProgramException|InvalidLiveProgramException]]: if the program id is invalid. | ||
|Cache= | |Cache= | ||
Revision as of 06:55, 9 June 2014
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
- 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.
- 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.
Returns
Returns a JSON object with a list of RecordingSchedule.
Example:
{
- "Offset": 0,
- "Limit": 10,
- "Count": 48,
- [ Array of RecordingSchedule objects ]
}
Exceptions
- AuthenticationRequiredException: if authentication parameters are incorrect/missing.
- MissingRequiredParameter: if a required parameter is missing.
- InvalidLiveProgramException: if the program id is invalid.
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
