Audio Gateways

Update audio gateway details

Update details for audio gateway. Note: uuid is a required field

POST/api/audiogateway/updateDetails

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request to update details for an audio gateway. Note: uuid is a required field.

associatedCamerasstring<DeviceFacetUuid>[] | nullbody

List of associated camera device UUIDs

associatedCamerasUpdatedboolean | nullbody

deletedboolean | nullbody

Indicates whether the audio gateway is deleted

Example: false

deletedUpdatedboolean | nullbody

descriptionstring | nullbody

Description of the audio gateway

Example: "Audio gateway for main entrance monitoring"

descriptionUpdatedboolean | nullbody

floorNumberinteger<int32> | nullbody

Floor number where the audio gateway is located

Example: 1

floorNumberUpdatedboolean | nullbody

latitudenumber<double> | nullbody

Latitude coordinate of the audio gateway location

Example: 37.7749

latitudeUpdatedboolean | nullbody

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationUuidUpdatedboolean | nullbody

longitudenumber<double> | nullbody

Longitude coordinate of the audio gateway location

Example: -122.4194

longitudeUpdatedboolean | nullbody

namestring | nullbody

Name of the audio gateway

Example: "Main Entrance Audio Gateway"

nameUpdatedboolean | nullbody

policyUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

policyUuidUpdatedboolean | nullbody

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | nullbody

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeyUpdatedboolean | nullbody

uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/audiogateway/updateDetails' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "associatedCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "associatedCamerasUpdated": true,
    "deleted": false,
    "deletedUpdated": false,
    "description": "Audio gateway for main entrance monitoring",
    "descriptionUpdated": true,
    "floorNumber": 1,
    "floorNumberUpdated": true,
    "latitude": 37.7749,
    "latitudeUpdated": true,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "locationUuidUpdated": true,
    "longitude": -122.4194,
    "longitudeUpdated": true,
    "name": "Main Entrance Audio Gateway",
    "nameUpdated": true,
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyUuidUpdated": true,
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "subLocationsHierarchyKeyUpdated": true,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }'

import requests

url = "https://api2.rhombussystems.com/api/audiogateway/updateDetails"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "associatedCamerasUpdated": True,
    "deleted": False,
    "deletedUpdated": False,
    "description": "Audio gateway for main entrance monitoring",
    "descriptionUpdated": True,
    "floorNumber": 1,
    "floorNumberUpdated": True,
    "latitude": 37.7749,
    "latitudeUpdated": True,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "locationUuidUpdated": True,
    "longitude": -122.4194,
    "longitudeUpdated": True,
    "name": "Main Entrance Audio Gateway",
    "nameUpdated": True,
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyUuidUpdated": True,
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "subLocationsHierarchyKeyUpdated": True,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/audiogateway/updateDetails', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "associatedCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "associatedCamerasUpdated": true,
    "deleted": false,
    "deletedUpdated": false,
    "description": "Audio gateway for main entrance monitoring",
    "descriptionUpdated": true,
    "floorNumber": 1,
    "floorNumberUpdated": true,
    "latitude": 37.7749,
    "latitudeUpdated": true,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "locationUuidUpdated": true,
    "longitude": -122.4194,
    "longitudeUpdated": true,
    "name": "Main Entrance Audio Gateway",
    "nameUpdated": true,
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyUuidUpdated": true,
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "subLocationsHierarchyKeyUpdated": true,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "associatedCameras": [
                "AAAAAAAAAAAAAAAAAAAAAA.v0"
              ],
              "associatedCamerasUpdated": true,
              "deleted": false,
              "deletedUpdated": false,
              "description": "Audio gateway for main entrance monitoring",
              "descriptionUpdated": true,
              "floorNumber": 1,
              "floorNumberUpdated": true,
              "latitude": 37.7749,
              "latitudeUpdated": true,
              "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "locationUuidUpdated": true,
              "longitude": -122.4194,
              "longitudeUpdated": true,
              "name": "Main Entrance Audio Gateway",
              "nameUpdated": true,
              "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "policyUuidUpdated": true,
              "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
              "subLocationsHierarchyKeyUpdated": true,
              "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/audiogateway/updateDetails"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response indicating the result of updating audio gateway details.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.