User Tools

Site Tools


api:iptv:whitelist:list

API : Whitelist List

Introduction

This request will return the list of whitelisted IPTV devices. Currently only supports tablets.

Request

URL https://api.telecomx.dk/iptv/whitelist
Method GET
Access level ADMIN.
Query offset [optional] Index of the first document to return, default 0.
limit [optional] The number of documents to return, default 100, min 1, max 500.
filter [optional] Filters whitelisted devices based on ID or serial.

Query examples

https://api.telecomx.dk/iptv/whitelist
https://api.telecomx.dk/iptv/whitelist?offset=50
https://api.telecomx.dk/iptv/whitelist?limit=30
https://api.telecomx.dk/iptv/whitelist?filter="2134"

Response

JSON object
offset Index of the first document returned.
limit Number of documents to return. Note that the actual number of documents returned may be lower.
total Number of documents that can be returned when offset and limit is not considered. This is to be used for paging through the data.
devices Array of documents, see definition below
Document object (JSON)
_id Id Unique barcode, put as a sticker on every IPTV Business tablet.
serial String Unique serial number from the device.
warrantyDate Date Date the tablets were purchased, used for warranty purposes.
model String Model of the device.
date Date Date and time when the status message was added.
invoiceNumber String Invoice number

Note that properties holding no value may be omitted from the object.

Example - normal

{
    "offset": 0,
    "limit": 100,
    "total": 2,
    "devices": [
        {
            "_id": "45678",
            "serial" "HKY7989898120",
            "model": "TC18",
            "warrantyDate": "2020-02-20T00:00:00",
            "invoiceNumber": "32"
        },
         {
            "_id": "12341234",
            "serial" "UYKH82819",
            "model": "TC21",
            "warrantyDate": "2020-05-20T00:01:00",
            "invoiceNumber": "31"
        },
    ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/iptv/whitelist/list.txt · Last modified: 2020/10/26 14:59 by Joakim Andersen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki