Update details for door sensor - Rhombus Developer Documentation

curl --request POST \ --url https://api2.rhombussystems.com/api/door/updateDetails \ --header 'Content-Type: application/json' \ --header 'x-auth-apikey: <api-key>' \ --header 'x-auth-scheme: <x-auth-scheme>' \ --data ' { "associatedCameras": [ "AAAAAAAAAAAAAAAAAAAAAA.v0" ], "associatedCamerasUpdated": true, "deleted": false, "deletedUpdated": false, "description": "Main entrance door sensor on the first floor", "descriptionUpdated": false, "floorNumber": 1, "floorNumberUpdated": true, "latitude": 37.7749, "latitudeUpdated": false, "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA", "locationUuidUpdated": true, "longitude": -122.4194, "longitudeUpdated": false, "name": "Main Entrance Door", "nameUpdated": true, "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA", "policyUuidUpdated": false, "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "subLocationsHierarchyKeyUpdated": false, "uuid": "AAAAAAAAAAAAAAAAAAAAAA" } '

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 sensor.

associatedCameras

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

List of associated camera device facet UUIDs

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

associatedCamerasUpdated

boolean | null

Whether the associated cameras have been updated

Example:

true

deleted

boolean | null

Whether the door sensor is deleted

Example:

false

deletedUpdated

boolean | null

Whether the deleted status has been updated

Example:

false

description

string | null

Description of the door sensor

Example:

"Main entrance door sensor on the first floor"

descriptionUpdated

boolean | null

Whether the description has been updated

Example:

false

floorNumber

integer<int32> | null

int32

Floor number where the door sensor is located

Example:

1

floorNumberUpdated

boolean | null

Whether the floor number has been updated

Example:

true

latitude

number<double> | null

double

Latitude coordinate of the door sensor

Example:

37.7749

latitudeUpdated

boolean | null

Whether the latitude has been updated

Example:

false

locationUuid

string<RUUID> | null

RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

locationUuidUpdated

boolean | null

Whether the location UUID has been updated

Example:

true

longitude

number<double> | null

double

Longitude coordinate of the door sensor

Example:

-122.4194

longitudeUpdated

boolean | null

Whether the longitude has been updated

Example:

false

name

string | null

Name of the door sensor

Example:

"Main Entrance Door"

nameUpdated

boolean | null

Whether the name has been updated

Example:

true

policyUuid

string<RUUID> | null

RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

policyUuidUpdated

boolean | null

Whether the policy UUID has been updated

Example:

false

subLocationsHierarchyKey

string<SubLocationsHierarchyKey> | null

SubLocationsHierarchyKey

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

uuid

string<RUUID> | null

RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

Response object for updating details for a door sensor.

error

boolean | null

errorMsg

string | null

warningMsg

string | null