Skip to main content
POST
/
api
/
component
/
updateAccessControlledDoor
Updates an access controlled door
curl --request POST \
  --url https://api2.rhombussystems.com/api/component/updateAccessControlledDoor \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "accessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "ajarTimeSec": 123,
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "associatedFaceDetectionCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "defaultState": "UNLOCKED",
  "directionRadians": 123,
  "doorStateToScheduleUuidMap": {},
  "dpiComponents": [
    {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "floorNumber": 123,
  "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled": true,
  "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled": true,
  "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled": true,
  "forceAllReadersRemoteUnlockAudioFeedbackEnabled": true,
  "forcedOpenEnabled": true,
  "forcedOpenTimeSec": 123,
  "geofenceEnabled": true,
  "geofenceRadius": 123,
  "latitude": 123,
  "longitude": 123,
  "name": "<string>",
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "proximityUnlockSettings": {
    "credCooldownSec": 123,
    "enabled": true,
    "exitResetsCooldown": true,
    "holdUnlocked": true,
    "holdUnlockedEventIntervalSec": 123,
    "maxHoldUnlockedTimeSec": 123,
    "minHoldUnlockedTimeSec": 123,
    "minRSSIThreshold": 123
  },
  "readerComponents": [
    {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "relayComponents": [
    {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "relockAfterOpenTimeMs": 123,
  "remoteUnlockEnabled": true,
  "rexComponents": [
    {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "unlockTimeSec": 123,
  "unlockTimeSecRex": 123,
  "waveToUnlockSettings": {
    "awaitAuthDurationMs": 123,
    "enabled": true,
    "minRSSIThreshold": 123,
    "showAwaitIntentFeedback": true,
    "treatNfcAsIntent": true
  }
}
'
{
  "accessControlledDoor": {
    "ajarTimeSec": 123,
    "aperioDoorExtensionComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "aperioDoorId": "<string>",
    "aperioGatewayComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "associatedCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "associatedFaceDetectionCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "createdAtMillis": 123,
    "defaultState": "UNLOCKED",
    "directionRadians": 123,
    "doorAuthFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>",
        "type": "USER"
      },
      "requestedAtMillis": 123,
      "state": "REQUIRED"
    },
    "doorScheduleFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>",
        "type": "USER"
      },
      "requestedAtMillis": 123,
      "state": "REQUIRED"
    },
    "doorStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>",
        "type": "USER"
      },
      "requestedAtMillis": 123,
      "type": "DOOR_STATE_OVERRIDE"
    },
    "doorStateToScheduleUuidMap": {},
    "dpiComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "floorNumber": 123,
    "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled": true,
    "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled": true,
    "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled": true,
    "forceAllReadersRemoteUnlockAudioFeedbackEnabled": true,
    "forcedOpenEnabled": true,
    "forcedOpenTimeSec": 123,
    "geofenceEnabled": true,
    "geofenceRadius": 123,
    "latitude": 123,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "longitude": 123,
    "name": "<string>",
    "nfcSecureDowngradeEnabled": true,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "privacyModeSupportEnabled": true,
    "proximityUnlockSettings": {
      "credCooldownSec": 123,
      "enabled": true,
      "exitResetsCooldown": true,
      "holdUnlocked": true,
      "holdUnlockedEventIntervalSec": 123,
      "maxHoldUnlockedTimeSec": 123,
      "minHoldUnlockedTimeSec": 123,
      "minRSSIThreshold": 123
    },
    "readerComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "relayComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "relockAfterOpenTimeMs": 123,
    "remoteUnlockEnabled": true,
    "rexComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "sendExpiredIntentEvents": true,
    "subType": "RHOMBUS",
    "type": "AccessControlledDoor",
    "unlockTimeSec": 123,
    "unlockTimeSecRex": 123,
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "waveToUnlockSettings": {
      "awaitAuthDurationMs": 123,
      "enabled": true,
      "minRSSIThreshold": 123,
      "showAwaitIntentFeedback": true,
      "treatNfcAsIntent": true
    }
  },
  "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
accessControlledDoorUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

ajarTimeSec
integer<int32> | null
associatedCameras
(string<DeviceFacetUuid> | null)[] | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

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

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

defaultState
enum<string>
Available options:
UNLOCKED,
ACCESS_CONTROLLED
directionRadians
number<float> | null
doorStateToScheduleUuidMap
object
dpiComponents
object[] | null
floorNumber
integer<int32> | null
forceAllReadersFirstInAuthRequiredLedFeedbackEnabled
boolean | null
forceAllReadersFirstInUnlockPendingLedFeedbackEnabled
boolean | null
forceAllReadersOtherReaderUnlockAudioFeedbackEnabled
boolean | null
forceAllReadersRemoteUnlockAudioFeedbackEnabled
boolean | null
forcedOpenEnabled
boolean | null
forcedOpenTimeSec
integer<int32> | null
geofenceEnabled
boolean | null
geofenceRadius
number<double> | null
latitude
number<double> | null
longitude
number<double> | null
name
string | null
policyUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

proximityUnlockSettings
object
readerComponents
object[] | null
relayComponents
object[] | null
relockAfterOpenTimeMs
integer<int32> | null
remoteUnlockEnabled
boolean | null
rexComponents
object[] | null
unlockTimeSec
integer<int32> | null
unlockTimeSecRex
integer<int32> | null
waveToUnlockSettings
object

Response

200 - application/json

OK

accessControlledDoor
object
error
boolean | null
errorMsg
string | null
warningMsg
string | null