API : Support cases List

Introduction

This request will return the list of all support cases

Request

URL	https://api.telecomx.dk/iptv/supportcase
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.
	customer	`[optional]` Customer ID, if provided it will only return the support cases of that customer.

Query examples

https://api.telecomx.dk/iptv/supportcase
https://api.telecomx.dk/iptv/supportcase?offset=50

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.
supportCases	Array of documents, see definition below

Document object (JSON)
_id	Id	Unique document id.
name	String	Name/subject of the support case
description	String	Description of the support case
customer	Id	Id of the customer that added the support case
customerName	String	Name of the customer that added the support case
employee	Id	Id of employee who that added the support case
employeeName	Id	Name of the employee that added the support case
solved	Boolean	If true, the case has been solved. If false, it is still ongoing
date	Date	Date and time when the support case was added.
lastUpdated	Date	Date and time when the support case was last updated.
device	Enum	The type of device which the user experienced issues with ANDROID, ANDROIDTV, APPLETV, CROMEMAC, CHROMEWINDOWS, DVB, FIREFOXMAC, FIREFOXWINDOWS, IOS, SAFARIMAC SAFARIWINDOWS, OTHER
privateInformation	String	For the customer to put in private information, that can only be seen by administrators and themselves. (ADMIN and creator of support case only)
systemVersion	String	Version of the system/device which the user experienced issues with
playMakerVersion	String	Version of the app which the user experienced issues with
files	Array	List of files on a support case
files[].id	Id	Unique document id.
files[].url	String	File url
files[].type	String	Type of file IMAGE or DOC
comments	Array	Comments on a support case
comments[]._id	Id	Unique document id.
comments[].comment	String	The response to the customer of the support case.
comments[].date	Date	Date and time of when the comment was created.
comments[].customer	Id	Id of the customer the employee belongs to
comments[].customerName	Id	Name of the customer the employee belongs to
comments[].employee	Id	Id of the employee who responded
comments[].employeeName	String	Name of the employee who responded
comments[].isSupport	Boolean	Whether this comment is made by a PlayMaker Supporter or not.
comments[].files	Array	List of files on a support case comment
comments[].files[].id	Id	Unique document id.
comments[].files[].url	String	File url
comments[].files[].type	String	Type of file IMAGE or DOC

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

Example - normal

{
    "offset": 198,
    "limit": 0,
    "total": 200,
    "supportCases": [
        {
           "_id": "1234567890ABCDEF12345678",
           "name": "Support til Huawei-telefoner",
           "description": "Kommer der support til Huawei-telefoner i den nære fremtid?",
           "customer": "1234567890ABCDEF12345678",
           "customerName": "Hansen Boligforening ApS",
           "employee": "1234567890ABCDEF12345678",
           "employeeName": "Hans Hansen",
           "solved": false,
           "date": "2020-02-17T14:36:09.698Z",
           "lastUpdated": "2020-02-17T14:36:09.698Z",
           "device": "ANDROID",
           "systemVersion": "1.03",
           "playMakerVersion": "1.23a",
           "privateInformation": "Vi skriver på vegne af Gertrud Gertudsen, hun kan kontaktes på +45 8888 9977",
           "files": [
              {
                 "_id": "1234567890ABCDEF12345678",
                 "url": "https://image.telecomx.dk/1234567890ABCDEF12345678.jpeg",
                 "type": "IMAGE"
              }
           ]
           "comments": [
               {
                  "_id": "1234567890ABCDEF12345678",
                  "comment": "Det virker nu :-) Tak!",
                  "date": "2020-02-17T14:36:09.698Z",
                  "customer": "1234567890ABCDEF12345678",
                  "customerName": "Hansen Boligforening ApS",
                  "employee": "1234567890ABCDEF12345678",
                  "employeeName": "Hans Hansen",
                  "isSupport": false,
                  "files": [
                     {
                        "_id": "1234567890ABCDEF12345678",
                        "url": "https://image.telecomx.dk/1234567890ABCDEF12345678.jpeg",
                        "type": "IMAGE"
                     }
                  ]    
               }   
           ]
        },
        {
            "_id": "1234567890ABCDEF12345678",
            "name": "Problemer med Viasat-kanaler",
            "description": "Det hakker i den store bagedyst, og underteksterne er på svensk.",
            "customer": "1234567890ABCDEF12345678",
            "customerName": "Skåne Boliger A/S",
            "employee": "1234567890ABCDEF12345678",
            "employeeName": "Knud Knudsen",
            "solved": true,
            "date": "2020-02-18T08:37:03.829Z",
            "lastUpdated": "2020-02-17T14:36:09.698Z",
            "device": "DVB",
            "systemVersion": "1.12.1",
            "playMakerVersion": "1.33.7",
            "comments": [],
            "privateInformation": "I kan ringe på +45 60 60 99 99, er nemlig ikke ved min computer resten af dagen."
        }
   ]
}

Errors

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

WIKI

Table of Contents

API : Support cases List

Introduction

Request

Query examples

Response

Example - normal

Errors