Access Control Integrations Webservice

Test Boulevard API connection

Test Boulevard API connection with provided credentials

post/api/integrations/accessControl/testBoulevardConnection

Request

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

apiTokenstring nullable

Boulevard API token to test

boulevardBusinessIdstring nullable

Boulevard business ID to test

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.

errorMessagestring nullable

Error message if connection test failed

errorMsgstring nullable
successboolean nullable

Whether the connection test was successful

warningMsgstring nullable

Changes

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