Skip to main content
POST
/
api
/
component
/
findMinimalStateAccessControlledDoorsByLocation
Find minimal state access controlled doors within the specified location
curl --request POST \
  --url https://api2.rhombussystems.com/api/component/findMinimalStateAccessControlledDoorsByLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "lastEvaluatedKey": "<string>",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "maxPageSize": 123
}
'
{
  "accessControlledDoors": [
    {
      "door": {
        "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
        }
      },
      "shadow": {
        "authFirstIn": {
          "originator": {
            "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "grantedToName": "<string>",
            "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "supportUserEmail": "<string>",
            "supportUsername": "<string>",
            "type": "USER"
          },
          "source": "CONFIG_MANUAL_OVERRIDE",
          "state": "DISABLED",
          "stateUpdateEventTimestampMs": 123
        },
        "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "createdAtMillis": 123,
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "scheduleFirstIn": {
          "originator": {
            "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "grantedToName": "<string>",
            "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "supportUserEmail": "<string>",
            "supportUsername": "<string>",
            "type": "USER"
          },
          "source": "CONFIG_MANUAL_OVERRIDE",
          "state": "DISABLED",
          "stateUpdateEventTimestampMs": 123
        },
        "state": {
          "source": "DEFAULT_STATE",
          "state": "UNLOCKED",
          "stateUpdateEventTimestampMs": 123
        },
        "type": "AccessControlledDoorShadow",
        "updatedAtMillis": 123
      }
    }
  ],
  "lastEvaluatedKey": "<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
lastEvaluatedKey
string | null
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

maxPageSize
integer<int32> | null

Response

200 - application/json

OK

accessControlledDoors
object[] | null
lastEvaluatedKey
string | null