Table of Contents

API : TV : Whitelist list

Introduction

This request will return the list of whitelisted STBs. Only whitelisted STB are permitted to connect to the TV platform.

Request

URL https://api.telecomx.dk/tv/whitelist
Method GET
Access level VIEWER, MANAGE, OWNER, RESELLER or ADMIN
Query offset [optional] Index of the first item to return, default 0.
limit [optional] The number of items to return, default 100, min 1, max 500.
filter [optional] Search query that will match against STB mac address.

Query examples

https://api.telecomx.dk/tv/whitelist
https://api.telecomx.dk/tv/whitelist?offset=10&limit=20&filter=01:0A:23:65:78:BD

Response

JSON object
offset Index of the first STB returned.
limit Number of STBs to return. Note that the actual number of returned STBs may be lower.
total Number of STBs that can be returned when offset and limit is not considered. This is to be used for paging through the data.
whitelist Array of STBs, see definition below.
STB object
_id Id MAC address of the STB.
warrentyDate Date Purchase date for the STB.
invoiceNumber String TCX invoice number.

Example

{
  offset: 0,
  limit: 100,
  total: 10,
  whitelist: [
    {
      id: '01:0A:23:65:78:BD',
      warrentyDate: '2016-01-01T00:00:00.000Z',
      invoiceNumber: '37567325'
    },
    {
      ...
    }
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>