Unlock Honeywell OnGuard door

Publishes an unlock command to the per-org STOMP topic that the OnGuard connector subscribes to. Fire-and-forget: returns success once the command is dispatched, the connector performs the actual relay and does not currently report back.

POST /api/integrations/accessControl/unlockHoneywellOnGuardDoor

Unlock Honeywell OnGuard door

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/integrations/accessControl/unlockHoneywellOnGuardDoor \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "doorId": "<string>"
}
'

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

cameraUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

doorId · string | null

Response

200 - application/json

OK

Response object for door unlock operations.

error · boolean | null

errorMsg · string | null

warningMsg · string | null