🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
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"
]
},
"defaultLockdownState": "LOCKED_DOWN",
"doorLockdownStateMap": {},
"lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"physicalAccess": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"testPlan": {
"doorStateOverrideEnabled": true,
"userAccessOverrideEnabled": true
}
}
'{
"lockdownPlan": {
"activationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"createdAtMillis": 123,
"deactivationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"defaultLockdownState": "LOCKED_DOWN",
"doorLockdownStateMap": {},
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"physicalAccess": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"testPlan": {
"doorStateOverrideEnabled": true,
"userAccessOverrideEnabled": true
},
"type": "ORG_LOCKDOWN",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Update location lockdown plan
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"
]
},
"defaultLockdownState": "LOCKED_DOWN",
"doorLockdownStateMap": {},
"lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"physicalAccess": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"testPlan": {
"doorStateOverrideEnabled": true,
"userAccessOverrideEnabled": true
}
}
'{
"lockdownPlan": {
"activationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"createdAtMillis": 123,
"deactivationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"defaultLockdownState": "LOCKED_DOWN",
"doorLockdownStateMap": {},
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"physicalAccess": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"testPlan": {
"doorStateOverrideEnabled": true,
"userAccessOverrideEnabled": true
},
"type": "ORG_LOCKDOWN",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9Request to update an existing location lockdown plan with selective field updates.
Show child attributes
Show child attributes
LOCKED_DOWN, ACCESS_CONTROLLED, UNLOCKED, UNKNOWN Show child attributes
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Show child attributes
Show child attributes
OK
Response containing the updated location lockdown plan.
The updated location lockdown plan.
Show child attributes
Was this page helpful?