Lockdown Plan Webservice

Activate lockdown for the specified location

Activate lockdown for the specified location

post/api/accesscontrol/lockdownPlan/activateLockdownForLocation

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/activateLockdownForLocation
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

lockdownPlanUuidsstring[] nullable

Set of lockdown plan UUIDs to activate for the location.

stateUpdatedAtMillisinteger nullable

Optional timestamp for optimistic locking to ensure the user is updating the latest record.

Example request

{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "lockdownPlanUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}

Response

OK

result'SUCCESS' | 'INVALID_LOCKDOWN_PLANS' | 'OPTIMISTIC_CONCURRENCY'

The result of the lockdown activation operation.

Example response

{
  "state": {
    "activeLockdownPlans": [
      {
        "lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.