Partner Webservice

Customize client device

Customize a client device

post/api/partner/customizeClientDevice

Request

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

clientDeviceUuidstring RUUID nullable

base 64 (url-safe) uuid string

clientOrgUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "clientDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "configUpdate": {
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "disabled_schedule_uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "region_of_interest_groups": [
      {
        "regionsOfInterest": [
          {
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ]
      }
    ],
    "shared_fov": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ]
  },
  "customizations": {
    "inactivityTimeout": 30
  }
}

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
warningMsgstring nullable

Example response

{
  "customizations": {
    "inactivityTimeout": 30
  }
}

Changes

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