Update location lockdown plan

Update location lockdown plan

POST /api/accesscontrol/lockdownPlan/updateLocationLockdownPlan

Update location lockdown plan

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/updateLocationLockdownPlan \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "activationPlan": {
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "rhombusKeyNotificationMessage": "<string>",
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "deactivationPlan": {
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "rhombusKeyNotificationMessage": "<string>",
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "doorLockdownStateMap": {},
  "lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "<string>",
  "physicalAccess": {
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "testPlan": {
    "doorStateOverrideEnabled": true,
    "userAccessOverrideEnabled": true
  }
}
'

200

{
  "lockdownPlan": {
    "activationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "createdAtMillis": 123,
    "deactivationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "doorLockdownStateMap": {},
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "physicalAccess": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "testPlan": {
      "doorStateOverrideEnabled": true,
      "userAccessOverrideEnabled": true
    },
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

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 update an existing location lockdown plan with selective field updates.

activationPlan · object

Show child attributes

deactivationPlan · object

Show child attributes

defaultLockdownState · enum<string>

Available options: LOCKED_DOWN, ACCESS_CONTROLLED, UNLOCKED, UNKNOWN

doorLockdownStateMap · object

Show child attributes

lockdownPlanUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

name · string | null

physicalAccess · object

Show child attributes

testPlan · object

Show child attributes

Response

200 - application/json

OK

Response containing the updated location lockdown plan.

lockdownPlan · object

The updated location lockdown plan.

Show child attributes