Skip to main content
POST
/
api
/
relay
/
getMinimalThirdPartyCameraStateList
Get minimal third party camera state list
curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/getMinimalThirdPartyCameraStateList \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "thirdPartyCameraStateList": [
    {
      "assignedNVRUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "assignedRelayCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "codec": "H.264",
      "connectionStatus": "RED",
      "createdAtMillis": 123,
      "defaultInterface": "<string>",
      "defaultInterfaceMac": "<string>",
      "directionRadians": 123,
      "discoveredByDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "externalIPAddress": "<string>",
      "facetNameMap": {},
      "firmwareUpdateInProgress": true,
      "firmwareVersion": "<string>",
      "floorNumber": 123,
      "healthStatus": "RED",
      "healthStatusDetails": "DISCONNECTED",
      "hwVariation": "RASPBERRY_PI_3",
      "lanAddresses": [
        "<string>"
      ],
      "lastRtspUrlStatus": "UNKNOWN",
      "lastVisibleLocationMs": {},
      "lastVisibleMs": {},
      "latitude": 123,
      "liveStreamShared": true,
      "liveStreamsSharedCount": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": 123,
      "manufacturer": "Hikvision",
      "mediaRegion": "<string>",
      "mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "model": "DS-2CD2142FWD-I",
      "mummified": true,
      "name": "<string>",
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "region": "<string>",
      "rtspUrl": "rtsp://192.168.1.100:554/stream1",
      "secondaryLanAddresses": [
        "<string>"
      ],
      "serialNumber": "<string>",
      "ssid": "<string>",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "supportedFacets": [
        "v0, a0"
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "wifiApMac": "<string>",
      "wifiBars": 123,
      "wifiSignalStrength": 123
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

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

Response

200 - application/json

OK

Response object containing basic state information about all third-party cameras in the organization.

error
boolean | null
errorMsg
string | null
thirdPartyCameraStateList
object[] | null

List of minimal third-party camera state information for all cameras in the organization

warningMsg
string | null