api:employee:get-shortcuts
Table of Contents
API : Get Employee Shortcuts
Introduction
This request will return the the shortcuts for an employee.
Request
| URL | https://api.telecomx.dk/employee/EMPLOYEE_ID/shortcuts | |
|---|---|---|
| Method | GET | |
| 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) |
Query example
https://api.telecomx.dk/employee/1234567890ABCDEF12345678/shortcuts
Response
| Array of shortcut objects (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. |
Example
shortcuts: [ { index: 0, url: '/customer/52f4fd7734697b28ccaf77ec', label: 'Northwind Industries' }, { index: 1, url: '/sip/?customer=52f4fd7734697b28ccaf77ec', label: 'Northwind Industries - SIP accounts' } ]
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | employee | Employee id not found in request URI |
| 403 | employee | Insufficient access level |
| 404 | employee | Employee not found |
api/employee/get-shortcuts.txt · Last modified: 2014/05/22 16:30 by Per Møller