Access Control Integrations Webservice

Update Openpath badge integration

Update Openpath badge integration

post/api/integrations/accessControl/updateOpenpathIntegration

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/integrations/accessControl/updateOpenpathIntegration
  • 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

{
  "openpathSettings": {
    "enablingUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rhombusToken": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Response

OK

authErrorboolean nullable

Whether an authentication error occurred during update

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
failedGuidsstring[] nullable

List of GUIDs that failed to update

misconfiguredDoorsstring[] nullable

List of door names that are assigned to multiple Rhombus locations

warningMsgstring nullable

Changes

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