API : PBX : Beacon : List

Request

This request returns the list of beacon a customer has, and optionally shared beacons.

URL	https://api.telecomx.dk/pbx/beacon
Method	GET
Access level	PERSONAL, VIEWER, MANAGER, OWNER if beacon belongs to the users customer RESELLER if customer belongs to the reseller, RESELLER_ADMIN and ADMIN.
Query	offset	`[optional]` Index of the first item to return, default 0.
	limit	`[optional]` The number of items to return, default 50, min 1, max 10000.
	filter	`[optional]` Search query that will match against the location and note fields.
	customer	`[optional]` Id of customer, defaults to the user own customer.
	shared	`[optional]` True to include shared beacons.

Query examples

https://api.telecomx.dk/pbx/beacon
https://api.telecomx.dk/pbx/beacon?limit=20&offset=100
https://api.telecomx.dk/pbx/beacon?filter=office

Response

JSON object
offset	Index of the first beacon returned.
limit	Number of beacons to return. Note that the actual number of returned beacons may be lower.
total	Number of beacons that can be returned when offset and limit is not considered. This is to be used for paging through the data.
beacons	Array of beacons, see definition below.

Beacon 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 - normal

{
  "offset": 0,
  "limit": 50,
  "total": 25,
  "beacons": [
    {
      "_id": "12345678901234567890ABDE",
      "uuid": "12345678-1234-1234-1234-123456789012",
      "major": 1,
      "minor": 23
      "customer": "1234567890123457890AADD",
      "shared": false,
      "location": "Main office",
      "note": "Reception desk",
      "lastSeen": "2020-01-01T00:00:00.000Z"
    },
    {
      ...
    }
  ]
}

Errors

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

WIKI

Table of Contents

API : PBX : Beacon : List

Request

Query examples

Response

Example - normal

Errors