Create a series recording request

Request

To create a series recording request, send a POST request to:

https://<host>:<port>/cdvr/v1/seriesrecordings

Quota management works as follows for series recording:

If the user does not have enough quota available to record the episode specified in the series recording request, (see below), the request fails and no episodes are recorded. (No retry is possible.)
If the user has enough quota available to record the episode specified in the series recording request, but does not have enough quota to record all the episodes, the service:
- Schedules as many episode recordings as possible within the available quota.
- Sets the maybeMissingEpisodes flag to true in the series recording object (as returned when you retrieve series recordings and requests).
  Once space has been freed up, the client application can repair a series recording, which will attempt to record the missing episodes.

Headers

Content-Type: application/json
Authorisation

Mandatory arguments

eventId – the ID of an episode in the series to be recorded
seriesType – specifies whether to record the whole series (SERIES) or just the season of the specified episode (SEASON).

Optional arguments

recordingOptions – specifies whether to record all the episodes (ALL_EPISODES, the default) or whether to omit (and not re-record) episodes that the user has deleted (DELETE_RERECORD).

Example

A POST request with this payload creates a series recording request for the series containing the episode with the specified event ID, with the following options:

Only the season containing the episode will be recorded (not all seasons)
All episodes will be recorded, regardless of whether the user has deleted any episodes.

CODE

{
   "seriesType":"SEASON",
   "eventId":"eastenders_10297",
   "recordingOptions":["ALL_EPISODES"]
}

Response

A successful request returns an HTTP 201 status.

A bad request returns an HTTP 400 staus.

An unsuccessful request returns an HTTP 401 status.

An HTTP 409 status is returned if either of the following is true:

The requested recording conflicts with an existing recording request, for example, if the user previously requested that all the seasons of a series be recorded and is now requesting that only a single season be recorded.
The user does not have enough quota available to record the episode specified in the request.