Update details for door controller

Update details for door controller. Note: uuid is a required field

POST /api/doorcontroller/updateDetails

Update details for door controller

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/doorcontroller/updateDetails \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

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 object for updating details for a door controller.

uuid · string<RUUID> | null · required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

description · string | null

Description of the door controller

Example:

"Controls access to the main entrance"

directionRadians · number<float> | null

Direction in radians for the door controller

Example:

1.5708

floorNumber · integer<int32> | null

Floor number where the door controller is located

Example:

1

latitude · number<double> | null

Latitude coordinate of the door controller

Example:

34.0522

locationUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

longitude · number<double> | null

Longitude coordinate of the door controller

Example:

-118.2437

name · string | null

Name of the door controller

Example:

"Main Entrance Controller"

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

Response object for updating details for a door controller.

error · boolean | null

errorMsg · string | null

warningMsg · string | null