Retrieve series recording statuses

Request

To retrieve the status of series recordings for the user, send a GET request to:

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

This request has a much smaller response size than that of GET /cdvr/v2/seriesrecordings.

This API supports:

• Limiting the number of records returned

• Paging

Headers

• Content-Type: application/json

• Authorisation

Mandatory arguments

None

Other arguments (in URL)

• limit – the number of records to return

• page – the page number to return (cannot be used without limit)
  For example:

  • ?limit=10 returns the first 10 recordings.

  • ?limit=10&page=2 returns the second 10 recordings.

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

Example

A successful request returns a payload that looks like this:

{
	"totalRecords": 5,
	"series": [
		{
			"id": "series1",
			"recordingId": "42499773-5f0a-4f11-839b-63d8324a6d73",
			"status": "ACTIVE"
		},
		{
			"id": "series2",
			"recordingId": "30220fd8-106c-4023-8b8b-ff896342e025",
			"status": "SUSPENDED"
		},
		{
			"id": "series3",
			"recordingId": "50220fd8-106c-4023-8b8b-ff896342e025",
			"status": "ACTIVE"
		}
	],
	"seasons": [
		{
			"id": "season1",
			"recordingId": "a544ad7a-5876-4b65-9b78-ff36eccad2e2",
			"status": "ACTIVE"
		},
		{
			"id": "season2",
			"recordingId": "0a0b8ac7-3555-4782-9aa6-c23d5d95366b",
			"status": "SUSPENDED"
		}
	]
}

See also

For full details of this API, see NPVR User Recordings API documentation v1 .