Skip to main content
POST
/
api
/
accesscontrol
/
lockdownPlan
/
findLocationLockdownEvents
Find location lockdown events
curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/findLocationLockdownEvents \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "createdAfterMs": 123,
  "createdBeforeMs": 123,
  "limit": 123
}
'
{
  "events": [
    {
      "createdAtMillis": 123,
      "followingTestPlan": true,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "originator": {
        "type": "USER"
      },
      "stateChangedAtMillis": 123,
      "type": "LOCKDOWN_ACTIVATED"
    }
  ]
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to find lockdown events for a specific location with optional time filtering.

locationUuid
string<RUUID> | null
required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

createdAfterMs
integer<int64> | null

Returns events created after (exclusive) the specified millisecond epoch timestamp

createdBeforeMs
integer<int64> | null

Returns events created before (exclusive) the specified millisecond epoch timestamp

limit
integer<int32> | null

Limits the number of returned events to the latest LIMIT events

Response

200 - application/json

OK

Response containing a list of lockdown events for a specific location.

events
object[] | null

List of lockdown events found for the specified location.