Create an access controlled door

Create an access controlled door

POST /api/component/createAccessControlledDoor

Create an access controlled door

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/component/createAccessControlledDoor \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "accessControlledDoor": {
    "ajarTimeSec": 123,
    "aperioDoorExtensionComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "aperioDoorId": "<string>",
    "aperioGatewayComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "associatedCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "associatedFaceDetectionCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "createdAtMillis": 123,
    "defaultAccessStateOriginator": {
      "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "grantedToName": "<string>",
      "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "supportUserEmail": "<string>",
      "supportUsername": "<string>"
    },
    "defaultAccessStateRequestedAtMillis": 123,
    "directionRadians": 123,
    "doorAuthFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>"
      },
      "requestedAtMillis": 123
    },
    "doorScheduleFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>"
      },
      "requestedAtMillis": 123
    },
    "doorStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>"
      },
      "requestedAtMillis": 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,
    "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,
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "unlockTimeSec": 123,
    "unlockTimeSecRex": 123,
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "waveToUnlockSettings": {
      "awaitAuthDurationMs": 123,
      "enabled": true,
      "minRSSIThreshold": 123,
      "showAwaitIntentFeedback": true,
      "treatNfcAsIntent": true
    }
  },
  "accessControlledDoorLabels": [
    "<string>"
  ]
}
'

200

{
  "accessControlledDoor": {
    "ajarTimeSec": 123,
    "aperioDoorExtensionComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "aperioDoorId": "<string>",
    "aperioGatewayComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "associatedCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "associatedFaceDetectionCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "createdAtMillis": 123,
    "defaultAccessStateOriginator": {
      "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "grantedToName": "<string>",
      "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "supportUserEmail": "<string>",
      "supportUsername": "<string>"
    },
    "defaultAccessStateRequestedAtMillis": 123,
    "directionRadians": 123,
    "doorAuthFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>"
      },
      "requestedAtMillis": 123
    },
    "doorScheduleFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>"
      },
      "requestedAtMillis": 123
    },
    "doorStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "grantedToName": "<string>",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportUserEmail": "<string>",
        "supportUsername": "<string>"
      },
      "requestedAtMillis": 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,
    "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,
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "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 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

accessControlledDoor · object

Show child attributes

accessControlledDoorLabels · (string | null)[] | null

Response

200 - application/json

OK

accessControlledDoor · object

Show child attributes

error · boolean | null

errorMsg · string | null

warningMsg · string | null