User Tools

Site Tools


api:iptv:statusmessages:list

API : Status messages List

Introduction

This request will return the list of all status messages

Request

URL https://api.telecomx.dk/iptv/statusmessage
Method GET
Access level RESELLER or ADMIN.
Customer feature IPTVBUSINESS or IPTVPRIVATE required.
Employee feature PLAYMAKERSTATUS required
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.

Query examples

https://api.telecomx.dk/iptv/statusmessage
https://api.telecomx.dk/iptv/statusmessage?offset=50
https://api.telecomx.dk/iptv/statusmessage?limit=30

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.
statusMessages Array of documents, see definition below
Document object (JSON)
_id Id Unique document id.
name String Name/subject of the status message
description String Description of the status message
solved Boolean If true, the status message has been solved. If false, it is still ongoing
date Date Date and time when the status message was added.
employee Id Id of employee who created the status message (ADMIN only)
employeeName String Name of employee who created the status message. If the requester is not ADMIN, it will show “PlayMaker Teamet”
lastUpdated Date Date and time when the status message was last updated.

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

Example - normal

{
    "offset": 0,
    "limit": 100,
    "total": 2,
    "statusMessages": [
        {
            "_id": "123456789ADBCDEFG",
            "name": "Alle DR kanaler er nede",
            "description": "Vi arbejder på sagen",
            "solved": false,
            "date": "2020-02-20T08:49:19.626Z",
            "lastUpdated": "2020-02-20T08:49:19.626Z",
            "employeeName": "PlayMaker Teamet",
        },
        {
            "_id": "123456789ADBCDEFG",
            "name": "Android TV virker heller ikke",
            "description": "Vi arbejder på sagen",
            "solved": false,
            "date": "2020-02-20T08:49:19.626Z",
            "lastUpdated": "2020-02-20T08:49:19.626Z",
            "employeeName": "PlayMaker Teamet",
        }
    ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/iptv/statusmessages/list.txt · Last modified: 2020/07/17 10:38 by Joakim Andersen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki