Create access revocation

Create a location access revocation

POST /api/accesscontrol/createAccessRevocation

Create access revocation

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/createAccessRevocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "accessRevocation": {
    "accessControlledDoorUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "accessControlledElevatorLandingUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "createdAtMillis": 123,
    "doorLabelIds": [
      "<string>"
    ],
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "storedInS3": true,
    "updatedAtMillis": 123,
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}
'

200

{
  "accessRevocation": {
    "accessControlledDoorUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "accessControlledElevatorLandingUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "createdAtMillis": 123,
    "doorLabelIds": [
      "<string>"
    ],
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "sortKey": "<string>",
    "storedInS3": true,
    "updatedAtMillis": 123,
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "error": true,
  "errorMsg": "<string>",
  "expiredACDLicensesDoorUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "unassignedACDLicensesDoorUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "warningMsg": "<string>"
}

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 create a location access revocation.

accessRevocation · object

The access revocation to update

Show child attributes

Response

200 - application/json

OK

Response for location access revocation creation.

accessRevocation · object

The access revocation to update

Show child attributes

error · boolean | null

errorMsg · string | null

expiredACDLicensesDoorUuids · (string<RUUID> | null)[] | null

Set of expired ACD license door UUIDs

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

unassignedACDLicensesDoorUuids · (string<RUUID> | null)[] | null

Set of unassigned ACD license door UUIDs

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg · string | null