Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Cameras

This endpoint allows you to retrieve a list of cameras associated with the account, with the ability to filter by account ID, location ID, bridge ID, multi-camera ID, and tags. It also supports pagination and the ability to include additional information about cameras. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available cameras, not the number of cameras resulting from the query string.

get/cameras

Query parameters

locationId__instring[]

List of Location IDs to filter on that is comma separated.

[
  "2428fda3-389f-48ce-b062-85875dd6b2e2"
]
bridgeId__instring[]

List of Bridge IDs to filter on that is comma separated.

[
  "00001106",
  "00001107"
]
multiCameraIdstring
Example:00001106

Filter to get cameras with given multiCameraId. multiCameraId=null returns cameras that are not multi camera cameras.

multiCameraId__nestring
Example:00001106

Filter to get cameras with multiCameraId that is not equal to given value.

multiCameraId__instring[]

List of multi camera IDs to filter on that is comma seperated.

[
  "00001106",
  "00001107"
]
tags__containsstring[]

List of tags associated with the file.

Tags filter.

[
  "family",
  "vacation"
]
tags__anystring[]

Filter to get only events associated with camera Ids mapped to the specified tag Ids. Accepts a comma-separated list of tag Ids (e.g., tagId_1,tagId_2). All matching camera IDs for the provided tag IDs will be included in the result. Here the suffix __any is used to indicate that the filter is an OR operation, i.e., events associated with any of the provided tag IDs will be included in the result.

[
  "Id_1"
]
packages__containsstring[]

Only return cameras that have enabled all packages in the list, separated by commas.

[
  "een.vsp"
]
layoutIdstring

Filter records by a specific layout ID.

name__containsstring

Filter to get the accounts whose name contains the provided substring. The lookup is exact and case insensitive.

name__instring[]

Filter to get the layouts whose name is on the provided list. The lookup is exact and case insensitive.

namestring

Name of the item.

Example:Video North Door 2022-08-03 23-04-50.mp4

Exact name of the item.

id__instring

Filter to get only records that have an ID that equals one of the given parameter values.

id__notInstring[]

Filter to exlude the users whose ids are in the provided list. The lookup is exact and case insensitive.

id__containsstring

Filter to get the cameras whose the id contains the provided substring. The lookup is exact and case insensitive

shareDetails.sharedboolean

If set to true, only cameras that are shared with the current account by another account will be returned. If set to false, the cameras that are shared with the current account will be filtered out.

shareDetails.accountIdstring

Filter to get the cameras that are shared from the provided account.

shareDetails.firstResponderboolean

If set to true, only cameras that are shared with the current account using the "First responder" feature will be returned. If set to false, the cameras that are shared with the current account using the "First responder" feature will be filtered out.

deviceInfo.directToCloudboolean

If set to true, only cameras that connect directly to the VMS cloud, and not through a bridge will be returned. If set to false, the cameras that connect directly to the VMS cloud will be filtered out.

speakerId__instring[]

Filter to get cameras that are a part of the given speaker esn.

speakerId__nestring nullable

Filter to get cameras whose speakerId is not equal to the given value. Use speakerId__ne=null to return only cameras that have a speakerId assigned.

qstring
Example:entrance

Text search that is applied to multiple fields. The fields being searched are defined by the backend and can be changed without warning. Example fields being searched: firstName, lastName, email.

qRelevance__gtenumber float
Example:0.5

Sets the current minimum similarity threshold that is used with the q parameter. The threshold must be between 0 and 1 (float, default is 0.5).

enabledAnalytics__containsstring[]

Only return cameras that have enabled all analytics in the comma-separated list.

[
  "een.tamperDetectionEvent.v1"
]
status__inDeviceConnectionStatus[]

Filter to get the devices with the specified status. The lookup is exact and case insensitive.

status__neDeviceConnectionStatus[]

Filter to get the devices with status that is not equal to the provided value. The lookup is exact and case insensitive.

includestring[]
pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

sortstring[]

Comma separated list of of fields that should be sorted. By default, the users response is sorted by first name.

  • sort= - not providing any value will result in error 400
  • sort=+firstName,+firstName - same values will result in error 400
  • sort=-firstName,+firstName - mutually exclusive values will return error 400
  • There is no limit on the number of sort fields. All available sort fields can be combined freely, as the backend supports sorting by all of them.
  • qRelevance is optional ordering parameter which is available if q filter is used, if q filter is not passed qRelevance as ordering parameter will return error 400

Response

OK

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger required

Size of the total result set.

Example response

{
  "results": [
    {
      "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"
        }
      ],
      "qRelevance": 0.5
    }
  ]
}
All 214 operations