Integrations Webservice

Update Device Integration

Update Device integration

post/api/integrations/updateDeviceIntegration

Request

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

createNewDeviceboolean nullable

Whether to create a new device

latitudenumber double nullable

Latitude coordinate of the device location

longitudenumber double nullable

Longitude coordinate of the device location

namestring nullable

Name of the device

updateDeviceboolean nullable

Whether to update an existing device

updateDeviceUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "createNewDevice": true,
  "deviceIntegrationSettings": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "latitude": 37.7749,
  "longitude": -122.4194,
  "name": "Main Entrance Camera",
  "updateDeviceUuid": "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.