API : PBX : Beacon : Create

Request

This request adds a new beacon to a customer.

URL	https://api.telecomx.dk/pbx/beacon
Method	POST
Access level	RESELLER_ADMIN and ADMIN.
Body	uuid	String	UUID of the beacon.
	major	Number	Major value: 0-65535.
	minor	Number	Minor value: 0-65535.
	customer	Id	The customer the beacon belongs to.
	shared	Boolean	True to let other customers also use the beacon.
	location	String	Name of the location where the beacon is installed.
	note	String	Optional note about the beacon and where it is located.

Body examples

{
  "uuid": "12345678-1234-1234-1234-123456789012",
  "major": 1,
  "minor": 23
  "customer": "1234567890123457890AADD",
  "shared": false,
  "location": "Main office",
  "note": "Main office, reception desk"
}

Response

The created beacon.

JSON object
_id	Id	Unique id of the beacon.
uuid	String	UUID of the beacon.
major	Number	Major value: 0-65535.
minor	Number	Minor value: 0-65535.
customer	Id	The customer the beacon belongs to.
shared	Boolean	True to let other customers also use the beacon.
location	String	Name of the location where the beacon is installed.
note	String	Optional note about the beacon and where it is located.
battery	Number	Battery level in percent.
lastSeen	Date	Date when beacon was last seen, if available.

Example

{
  "_id": "12345678901234567890ABDE",
  "uuid": "12345678-1234-1234-1234-123456789012",
  "major": 1,
  "minor": 23
  "customer": "1234567890123457890AADD",
  "shared": false,
  "location": "Main office",
  "note": "Main office, reception desk",
  "lastSeen": "2020-01-01T00:00:00.000Z"
}

Errors

Error code	Message	Description
409	uuid	Beacon already exists
409	uuid	Beacon already exists on another customer
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : PBX : Beacon : Create

Request

Body examples

Response

Example

Errors