AudioGateway Webservice

Update audio gateway details

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

post/api/audiogateway/updateDetails

Request

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

associatedCamerasstring[] nullable

List of associated camera device UUIDs

associatedCamerasUpdatedboolean nullable
deletedboolean nullable

Indicates whether the audio gateway is deleted

deletedUpdatedboolean nullable
descriptionstring nullable

Description of the audio gateway

descriptionUpdatedboolean nullable
floorNumberinteger nullable

Floor number where the audio gateway is located

floorNumberUpdatedboolean nullable
latitudenumber double nullable

Latitude coordinate of the audio gateway location

latitudeUpdatedboolean nullable
locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

locationUuidUpdatedboolean nullable
longitudenumber double nullable

Longitude coordinate of the audio gateway location

longitudeUpdatedboolean nullable
namestring nullable

Name of the audio gateway

nameUpdatedboolean nullable
policyUuidstring RUUID nullable

base 64 (url-safe) uuid string

policyUuidUpdatedboolean nullable
subLocationsHierarchyKeystring SubLocationsHierarchyKey nullable

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

subLocationsHierarchyKeyUpdatedboolean nullable
uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "description": "Audio gateway for main entrance monitoring",
  "floorNumber": 1,
  "latitude": 37.7749,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -122.4194,
  "name": "Main Entrance Audio Gateway",
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

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

Changes

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