Find location lockdown events

Retrieve a list of lockdown events for the specified location

POST /api/accesscontrol/lockdownPlan/findLocationLockdownEvents

Find location lockdown events

cURL

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"
}
'

200

{
  "events": [
    {
      "createdAtMillis": 123,
      "followingTestPlan": true,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "originator": {},
      "stateChangedAtMillis": 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 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.

Show child attributes