Skip to main content
POST
/
api
/
doorcontroller
/
updateDetails
Update details for door controller
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",
  "description": "Controls access to the main entrance",
  "directionRadians": 1.5708,
  "floorNumber": 1,
  "latitude": 34.0522,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -118.2437,
  "name": "Main Entrance Controller"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

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"

Response

200 - application/json

OK

Response object for updating details for a door controller.

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null