Find location lockdown states

Finds the state of all lockdowns for the org

POST /api/accesscontrol/lockdownPlan/findLocationLockdownStates

Find location lockdown states

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/findLocationLockdownStates \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "stateFilter": []
}
'

200

{
  "states": [
    {
      "activeLockdownPlans": [
        {
          "lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "createdAtMillis": 123,
      "followingTestPlan": true,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "stateChangedAtMillis": 123,
      "updatedAtMillis": 123
    }
  ]
}

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 to find location lockdown states with optional filtering.

stateFilter · enum<string>[] | null

Optional filter to limit results to specific lockdown states.

Available options: STANDARD_SECURITY, LOCKED_DOWN

Response

200 - application/json

OK

Response containing a list of location lockdown states.

states · object[] | null

List of location lockdown states found for the organization.

Show child attributes