Lockdown Plan Webservice

Create lockdown rule for location

Create (or update if ruleUuid is provided) a lockdown rule for the specified location

post/api/accesscontrol/lockdownPlan/createLockdownRuleForLocation

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLockdownRuleForLocation
  • 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

Example request

{
  "rule": {
    "action": {
      "activateLocationLockdown": {
        "locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "audioPlaybackActions": [
        {
          "audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ]
        }
      ],
      "cancelLoopingAudioPlaybackAction": {
        "_audioDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA.v0"
        ],
        "audioDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA.v0"
        ]
      },
      "changeComponentCompositeAccessStateActions": [
        {
          "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "connectAudioDeviceToMobileAppAction": {
        "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "targetDoorStationUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "targetUserUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "connectAudioDeviceToPhoneNumberAction": {
        "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "doorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "createAlarmAction": {
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "mediaDeviceUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA.v0"
        ],
        "sirenSettings": {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        },
        "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
      },
      "customLLMActions": [
        {
          "deviceFacetUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA.v0"
          ],
          "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "enableDisableAudioRecordActions": [
        {
          "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "robotActions": [
        {
          "mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "thirdPartyAudioPlaybackAction": {
        "proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "thirdPartyStrobeSirenAction": {
        "proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "triggerComponentRelayActions": [
        {
          "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ]
    },
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ruleFilters": {
      "scheduleUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
ruleUuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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