Access Control Webservice

Update access grant

Updates a location access grant

post/api/accesscontrol/updateAccessGrant

Request

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

{
  "accessGrant": {
    "accessControlledDoorUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "accessControlledElevatorLandingUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "locationGuestPassUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "uuid": "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
expiredACDLicensesDoorUuidsstring[] nullable

Set of expired ACD license door UUIDs

unassignedACDLicensesDoorUuidsstring[] nullable

Set of unassigned ACD license door UUIDs

warningMsgstring nullable

Example response

{
  "accessGrant": {
    "accessControlledDoorUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "accessControlledElevatorLandingUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "locationGuestPassUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "expiredACDLicensesDoorUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "unassignedACDLicensesDoorUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}

Changes

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