API : Set Employee Shortcuts

Introduction

This request will set the the shortcuts for an employee.

Request

URL	https://api.telecomx.dk/employee/EMPLOYEE_ID/shortcuts
Method	POST
Access level	VIEWER, MANAGER or OWNER if user belongs to the customer of the employee. RESELLER if customer belongs to the reseller and employee belongs to the customer. ADMIN.
Param	EMPLOYEE_ID	Id of the employee (24 hex-char string)
Body	Array	Array of shortcut objects.

Shortcut object (JSON)
index	Integer	Index of the item in the list of items.
url	String	URL in the API for accessing the data.
label	String	Label to show in the API. Special labels: '—' and no url = horizontal line and a label without a url is a section header.

Request body example

[
  {
    index: 0,
    url: '/customer/52f4fd7734697b28ccaf77ec',
    label: 'Northwind Industries'
  },
  {
    index: 1,
    url: '/sip/?customer=52f4fd7734697b28ccaf77ec',
    label: 'Northwind Industries - SIP accounts'
  }
]

Response

Json object
success	Boolean	True on success.

Example

{
  success: true
}

Errors

Error code	Message	Description
400	employee	Employee id not found in request URI
400	shortcuts	Shortcuts not found in body
403	employee	Insufficient access level
404	employee	Employee not found

WIKI

Table of Contents

API : Set Employee Shortcuts

Introduction

Request

Request body example

Response

Example

Errors