Delete a series recording request and/or recording
Request
To delete a series recording request and/or its recordings, send a DELETE request to:
https://<host>:<port>/cdvr/v1/seriesrecordings/{id}
This cancels the recording request – no further recordings of the series will be made. If the optional deleteUserRecordings
parameter is set to true, all the existing recordings of the series are deleted.
Any bookmark or "favourite" records will also be deleted should user recording be deleted.
Headers
Content-Type: application/json
- Authorisation
Mandatory arguments
id
– the ID of the series recording (as returned in theid
field in therecordings
object when you retrieve series recordings/requests)
Other arguments
deleteUserRecordings
– whether to delete existing recordings of the series (true
) or not (false
). The default isfalse
.
Example
A DELETE request like this cancels the series recording request for "Friends" and also deletes all existing recordings:
http://<host>:<port>/cdvr/v1/seriesrecordings/Friends?deleteUserRecordings=true
Response
A successful request returns an HTTP 204 status.
An unauthorised request returns an HTTP 401 status.
See also
For full details of this API, see User Recordings API documentation.