OpenTV ENTera & OpenTV Platform Documentation

Get device data

Request

To get the data for a device, send a GET request to:

XML
https://<server>:<port>/adm/v1/user/devices

This does not take any parameters and does not have a payload. The header must contain a token to identify the account; for details of the header fields see  Get all devices by token header.

Headers

  • x-correlation-id – identifier for logging, to correlate messages across a call flow.

  • nv-tenant-id – the tenant ID.

  • token – request authentication token.

Response

A successful request returns an HTTP 200 status.

Click here for an example of a successful response.
JavaScript
{
  "totalRecords": 1,
  "resourceSet": [
    {}
  ]
}

A bad request returns an HTTP 400 status.

If the supplied credentials (token) are not valid, the request returns an HTTP 401 status.

A forbidden request returns an HTTP 403 status.

If the resource does not exist, the request returns an HTTP 404 status.

An internal server error returns an HTTP 500 status.

Click here for an example of an error case.
JavaScript
{
  "message": "string",
  "code": 0,
  "errorCode": 0
}

See also

For full details of this API, see Account and Device Manager (ADM) API documentation.