Relay Webservice

Get minimal third party camera state list

Get basic state information about all third party cameras in the organization

post/api/relay/getMinimalThirdPartyCameraStateList

Request

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

RelayGetMinimalThirdPartyCameraStateListWSRequest required

Request object for getting basic state information about all third-party cameras in the organization.

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

{
  "thirdPartyCameraStateList": [
    {
      "assignedNVRUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "assignedRelayCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "codec": "H.264",
      "discoveredByDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "manufacturer": "Hikvision",
      "mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "model": "DS-2CD2142FWD-I",
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rtspUrl": "rtsp://192.168.1.100:554/stream1",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "supportedFacets": [
        "v0, a0"
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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