api:pbx:beacon:update
Table of Contents
API : PBX : Beacon : Update
Request
This request updates an existing beacon.
| URL | https://api.telecomx.dk/pbx/beacon/ID | ||
|---|---|---|---|
| Method | POST | ||
| Access level | MANAGE, OWNER if beacon belongs to the users customer RESELLER if customer belongs to the reseller, RESELLER_ADMIN and ADMIN. |
||
| Params | ID | String | Id of beacon. |
| Body | 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
{ "note": "Reception desk near socket A12" }
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": "Reception desk, near socket A12", "lastSeen": "2020-01-01T00:00:00.000Z" }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | id | Beacon not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/beacon/update.txt · Last modified: 2025/06/11 09:00 by Per Møller