Activate lockdown for the specified location

Activate lockdown for the specified location

POST /api/accesscontrol/lockdownPlan/activateLockdownForLocation

Activate lockdown for the specified location

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/activateLockdownForLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "lockdownPlanUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "stateUpdatedAtMillis": 123
}
'

200

{
  "state": {
    "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 activate lockdown for a specific location with optional optimistic locking.

locationUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

lockdownPlanUuids · (string<RUUID> | null)[] | null

Set of lockdown plan UUIDs to activate for the location.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

stateUpdatedAtMillis · integer<int64> | null

Optional timestamp for optimistic locking to ensure the user is updating the latest record.

Response

200 - application/json

OK

Response containing the result of activating lockdown for a location.

result · enum<string>

The result of the lockdown activation operation.

Available options: SUCCESS, INVALID_LOCKDOWN_PLANS, OPTIMISTIC_CONCURRENCY

state · object

The lockdown state for the location.

Show child attributes