API : PBX : Variable list

Introduction

This request will return a list of all the variables a PBX has.

Request

URL	https://api.telecomx.dk/pbx/variable
Method	GET
Access level	PERSONAL, VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN.
Query	customer	`[optional]` Id of customer to show variables for. Defaults to the users own customer if not specified.

Query examples

https://api.telecomx.dk/pbx/variable
https://api.telecomx.dk/pbx/variable?customer=123458789012457890ABCD

Response

Array of JSON objects.

Property	Type	Description
name	String	Name of variable. If type is SHARED this is prefixed with: SHARED:. If type is PERSONAL this is prefixed with <employee-id>:.
value	String	Value of variable.
type	String	Type of variable: SYSTEM, SHARED, PERSONAL.
employee	Object	Info on employee this variable belongs to, if type is PERSONAL.
employee._id	Id	Id of employee.
employee.name	String	Name of employee.

Example

[
  {
    "name": "onduty",
    "value": "203",
    "type": "SYSTEM"
  },
  {
    "name": "12345678901234567890ABCD:room",
    "value": "203A",
    "type": "PERSONAL",
    "employee": {
      "_id": "12345678901234567890ABCD",
      "name": "Donald Duck"
    }
  },
  {
    ...
  }
]

Errors

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

WIKI

Table of Contents

API : PBX : Variable list

Introduction

Request

Query examples

Response

Example

Errors