API : PBX : APP : Dashboard List

Introduction

This request will return the list of dashboards that an employee has.

Dashboards are used in the Desktop Communicator app.

Request

URL	https://api.telecomx.dk/pbx/app/dashboard
Method	GET
Access level	PERSONAL if fetching own dashboards VIEWER, MANAGER, OWNER if fetching an employees dashboard RESELLER if fetching a customers employees dashboards ADMIN.
Query	employee	`[optional]` Id of employee to fetch dashboards for. Defaults to user self.
Query	customer	`[optional]` Id of customer. If set and user is at least VIEWER, then a complete list of employees and their dashboards are returned. Mutually exclusive with `employee`.

Query examples

https://api.telecomx.dk/pbx/app/dashboard
https://api.telecomx.dk/pbx/app/dashboard?employee=12345678901234567890ABCD
https://api.telecomx.dk/pbx/app/dashboard?customer=1234567801234567890AAAA

Response (default and when employee is given)

Array of JSON objects.

JSON object
_id	Id	Unique id of the dashboard.
name	String	Name of the dashboard.
topbar	Number	Priority in the topbar, 0=do not display in topbar, 1-5 positional priority
shared	Boolean	True if dashboard is a shared dashboard.

Example

[
  {
    "_id": "12345678901234567890ABCD",
    "name": "Reception",
    "topbar": 0,
    "shared": false
  },
  {
    "_id": "12345678901234567890AAAA",
    "name": "Support dash",
    "topbar": 0,
    "shared": true
  }
]

Response (When customer is given)

Array of JSON objects.

JSON object
_id	Id	Unique id of employee, null if shared dashboards.
name	String	Name of employee, Shared if shared dashboards.
shared	Boolean	True if dashboard is shared.
dashboards	Array	List of dashboards
dashboards[]._id	Id	Unique id of the dashboard.
dashboards[].name	String	Name of the dashboard.

Example

[
  {
    "_id": null,
    "name": "Shared",
    "shared": true,
    "dashboards": [
      {
        "_id": "123456789012345678908888",
        "name": "Supporters",
        "topbar": 0
      },
      {
        "_id": "123456789012345678909999",
        "name": "Finance",
        "topbar": 0
      }
    ]
  },
  {
    "_id": "12345678901234567890BBBB",
    "name": "Donald Duck",
    "shared": false,
    "dashboards": [
      {
        "_id": "12345678901234567890ABCD",
        "name": "Reception",
        "topbar": 0
      },
      {
        "_id": "12345678901234567890AAAA",
        "name": "Support dash",
        "topbar": 0
      }
    ]
  },
  {
     ...
  }
]

Errors

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

WIKI

Table of Contents

API : PBX : APP : Dashboard List

Introduction

Request

Query examples

Response (default and when employee is given)

Example

Response (When customer is given)

Example

Errors