API : Support cases Update

Introduction

This request will update a given support case.

Request

URL	https://api.telecomx.dk/iptv/supportcase/SUPPORTCASE_ID
Method	POST
Access level	ADMIN.
Param	SUPPORTCASE_ID	Id of the support case (24 hex-char string)
Body	_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
	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
	response	Object	A response given by a supporter/administrator
	response.author	String	The author shown to the customer, defaults to 'PlayMaker Teamet'
	response.answer	String	The response to the customer of the support case.
	response.date	Date	Date and time when the response was given.
	response.employee	Id	Id of the employee who responded (ADMIN only)
	response.employeeName	String	Name of the employee who responded (ADMIN only)
	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)
	files	Array	List of files
	files[].id	Id	Unique document id.
	files[].url	String	File url
	files[].type	String	Type of file IMAGE or DOC
	date	Date	Date and time when the support case was added.
	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 belongs to a comment
	comments[].files[].id	Id	Unique document id.
	comments[].files[].url	String	File url
	comments[].files[].type	String	Type of file IMAGE or DOC

Query examples

https://api.telecomx.dk/iptv/supportcase

Response

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

{
   "_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"
             }
          ]    
       }   
   ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	not_found	Support case not found
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : Support cases Update

Introduction

Request

Query examples

Response

Example - normal

Errors