Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Cameras

Retrieves the given camera.

get/cameras/{cameraId}

Query parameters

includestring[]

Response

OK

idstring required
accountIdstring required
namestring required

User-defined name for the device.

bridgeIdstring required

The bridge a camera is connected to. Keep in mind that some cameras are connected directly to the cloud, which is when this field will not be reported.

locationIdstring nullable

ID Of the location.

multiCameraIdstring nullable
createTimestampstring date-time required
speakerIdstring nullable

Optional unique identifier of the speaker device associated with this camera. This should be a speaker that is audible to anyone visible in the camera view, allowing an operator to talk to visible people.

notesstring
tagsstring[]
visibleByBridgesstring[]
packagesstring[]

List of packages enabled for a camera.

Example response

{
  "name": "My new device",
  "bridgeId": "1000f60d",
  "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2",
  "createTimestamp": "2023-04-04T09:38:37.372Z",
  "statusV2": {
    "cloudConnectionStatus": "connected",
    "edgeReportedDeviceStatus": "operational",
    "deviceSpecificError": "generalDeviceError"
  },
  "bridgeSummary": {
    "id": "1000f60d",
    "name": "Front Lobby Bridge"
  },
  "speakerId": "10039dab",
  "timeZone": {
    "zone": "America/Chicago"
  },
  "notes": "Painted black to better blend with its environment.",
  "devicePosition": {
    "latitude": 52.3074013,
    "longitude": 4.9459903,
    "azimuth": 7.419435,
    "rangeInMeters": 50.4,
    "floor": 50,
    "fieldOfView": 100
  },
  "networkInfo": {
    "globalIP": "10.143.55.140",
    "ipUsedByBridge": "10.143.55.140",
    "adapters": [
      {
        "macAddress": "8A:D4:AD:09:DF:91",
        "ipAddress": "10.143.55.140"
      }
    ]
  },
  "deviceInfo": {
    "guid": "ddfa5b34-5d04-431e-8287-110fe87edf71"
  },
  "firmware": {
    "currentVersion": "v20211019_542_3022"
  },
  "visibleByBridges": [
    "1000f60d"
  ],
  "shareDetails": {
    "accountId": "00009983",
    "accountName": "EEN Demo."
  },
  "analog": {
    "input": 1
  },
  "packages": [
    "een.vsp",
    "een.pos"
  ],
  "dewarpConfig": {
    "cameraId": "1007ff4e",
    "fov": 180,
    "curve": "equidistant",
    "mount": "ceiling",
    "scale": {
      "x": 0.5,
      "y": 0.5
    },
    "offset": {
      "x": 0.5,
      "y": 0.5
    },
    "composites": [
      {
        "id": "41770c16-600f-4ad5-a0d0-1fb96905603e",
        "name": "Quad view",
        "aspect": 1.77778,
        "panes": [
          {
            "x": "50%",
            "y": "50%",
            "width": "50%",
            "height": "50%",
            "shader": "sphere",
            "fov": 45,
            "lookAt": {
              "x": 1,
              "y": -1,
              "z": 0.5
            }
          }
        ]
      }
    ]
  },
  "enabledAnalytics": [
    {
      "creatorId": "een.bridgeTampering",
      "type": "een.tamperDetectionEvent.v1"
    }
  ]
}