Skip to main content

Recording Request

This is a JSON object with the following fields:

Name
Type
Description
Localised
Always available
_idStringInternal identifier for the object.NoYes
accountNumberStringThe account number requesting the recording.NoYes
availabilityEndDateDateThe availability end date of the recording request.NoYes
availabilityStartDateDateThe availability start date of the recording request.NoYes
channelIdStringThe main channel ID of the event.NoYes
contentIdStringThe metadata content identifier.NoYes
createdDateThe date that the recording request was created.NoYes
deviceTypeArray of stringsThe device types supported by this recording request for example, ios or stb.NoYes
durationLongThe duration of the content.NoYes
isprotectedBooleanA 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.NoYes
modifiedDateThe date that the recording request was modified.NoYes
programmeIdStringThe programme ID of the event to be recorded. Maps to the programme.id in MDS.NoYes
programmeMetaDataMapThe 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.NoYes
seriesIdStringThe metadata series identifier.NoYes
serviceProviderPublicIdStringThe Service Provider name.NoYes
statusStringThe status of the recording request.NoYes
uriStringThe URI of the recording request.NoYes
workflowVersionIntegerThe workflow version corresponding to the nPVR capability.NoYes

Example

CODE
{
    "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"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.