Update button details

Update details for a button sensor.

POST /api/button/updateDetails

Update button details

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/button/updateDetails \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "description": "<string>",
  "floorNumber": 1,
  "latitude": 37.7749,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -122.4194,
  "name": "<string>",
  "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKeyUpdated": false
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request to update button sensor details.

associatedCameras · (string<DeviceFacetUuid> | null)[] | null

List of associated camera device UUIDs

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

buttonMode · enum<string>

Optional button mode configuration

Available options: PANIC, PROGRAMMABLE, DOORBELL, NONE

description · string | null

Optional description for the button sensor

floorNumber · integer<int32> | null

Optional floor number

Example:

1

latitude · number<double> | null

Optional latitude coordinate

Example:

37.7749

locationUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

longitude · number<double> | null

Optional longitude coordinate

Example:

-122.4194

name · string | null

Optional name for the button sensor

sensorUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKey · string<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example:

"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeyUpdated · boolean | null

Whether the sub-locations hierarchy key has been updated

Example:

false

Response

200 - application/json

OK

error · boolean | null

errorMsg · string | null

warningMsg · string | null