Camera Webservice

Get minimal camera list

Use /getMinimalCameraStateList instead

post/api/camera/getMinimalList

Request

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

includeMummifiedboolean nullable

Whether to include mummified cameras in the response

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

{
  "cameras": [
    {
      "defaultInterface": "eth0",
      "defaultInterfaceMac": "00:11:22:33:44:55",
      "floorNumber": 1,
      "latitude": 37.7749,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "mediaRegion": "us-west-1",
      "name": "Front Door Camera",
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "region": "us-west-1",
      "serialNumber": "CAM123456789",
      "ssid": "MyNetwork",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "wifiApMac": "AA:BB:CC:DD:EE:FF",
      "wifiBars": 4,
      "wifiSignalStrength": -45
    }
  ]
}

Changes

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