Recording Request
This is a JSON object with the following fields:
Name | Type | Description | Localised | Always available |
---|---|---|---|---|
_id | String | Internal identifier for the object. | No | Yes |
accountNumber | String | The account number requesting the recording. | No | Yes |
availabilityEndDate | Date | The availability end date of the recording request. | No | Yes |
availabilityStartDate | Date | The availability start date of the recording request. | No | Yes |
channelId | String | The main channel ID of the event. | No | Yes |
contentId | String | The metadata content identifier. | No | Yes |
created | Date | The date that the recording request was created. | No | Yes |
deviceType | Array of strings | The device types supported by this recording request for example, ios or stb . | No | Yes |
duration | Long | The duration of the content. | No | Yes |
isprotected | Boolean | A flag to indicate whether the recording request can be deleted fully. This field should be set to true if DELETE should not be allowed and to false if it should. | No | Yes |
modified | Date | The date that the recording request was modified. | No | Yes |
programmeId | String | The programme ID of the event to be recorded. Maps to the programme.id in MDS. | No | Yes |
programmeMetaData | Map | The programme metadata, sourced from the MDS. This can be applied when the recording request is created with a POST, but will be overwritten when the programme moves to RECORDING state with the latest copy from MDS. | No | Yes |
seriesId | String | The metadata series identifier. | No | Yes |
serviceProviderPublicId | String | The Service Provider name. | No | Yes |
status | String | The status of the recording request. | No | Yes |
uri | String | The URI of the recording request. | No | Yes |
workflowVersion | Integer | The workflow version corresponding to the nPVR capability. | No | Yes |
Example
{
"accountNumber": "910-5754255",
"programmeId": "6033_531",
"created": 1394127591406,
"modified": 1394127591406,
"status": "NEW",
"uri": "http://127.0.0.1:7777/api/npvrlocker/v1/recordingrequests/KBRO/5318b2f8e4b00c4a6e839f01"
}