Get or create location lockdown state
curl --request POST \
--url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'import requests
url = "https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState"
payload = { "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA" }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA'})
};
fetch('https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n}")
.asString();{
"state": {
"activeLockdownPlans": [
{
"lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"scope": "ORG_LOCKDOWN",
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"createdAtMillis": 123,
"followingTestPlan": true,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"state": "STANDARD_SECURITY",
"stateChangedAtMillis": 123,
"updatedAtMillis": 123
}
}Lockdown Plan Webservice
Get or create location lockdown state
Retrieves an existing lockdown state or creates one for the specified location
POST
/
api
/
accesscontrol
/
lockdownPlan
/
getOrCreateLocationLockdownState
Get or create location lockdown state
curl --request POST \
--url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'import requests
url = "https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState"
payload = { "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA" }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA'})
};
fetch('https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n}")
.asString();{
"state": {
"activeLockdownPlans": [
{
"lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"scope": "ORG_LOCKDOWN",
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"createdAtMillis": 123,
"followingTestPlan": true,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"state": "STANDARD_SECURITY",
"stateChangedAtMillis": 123,
"updatedAtMillis": 123
}
}Authorizations
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
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 retrieve an existing lockdown state or create one for a specific location.
base 64 (url-safe) uuid string
Example:
"AAAAAAAAAAAAAAAAAAAAAA"
Response
200 - application/json
OK
Response containing the lockdown state for the specified location.
The lockdown state for the location.
Show child attributes
Show child attributes
Last modified on September 6, 2026