AudioGateway Webservice

Get full audio gateway state

Get detailed information about state of specified audio gateway

post/api/audiogateway/getFullAudioGatewayState

Request

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

deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

forceboolean nullable

Force refresh of the device state

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

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

{
  "fullAudioGatewayState": {
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "supportedFacets": [
      "v0, a0"
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

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