Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Multi Cameras

This endpoint allows you to retrieve a list of multi cameras for a given account and location. Multi cameras are devices such as DVRs that have multiple cameras connected.
It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available multi cameras, not the number of multi cameras resulting from the query string.

get/multiCameras

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"
]
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).

sortstring[]

Comma separated list of of fields that should be sorted.

  • sort= - not providing any value will result in error 400
  • sort=+name,+name - same values will result in error 400
  • sort=-name,+name - mutially exclusive values will return error 400
  • maxItem=2 - Only Three values will be accepted, more will return error 400
  • 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
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[]

The fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. You can use the special value * during development to return all fields, however, to achieve better performance, it is advisable to explicitly select only the fields you need.

[
  "accountId",
  "publicShare",
  "notes",
  "createTimestamp",
  "updateTimestamp",
  "size",
  "metadata",
  "tags",
  "childCount",
  "details"
]
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.

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": [
    {
      "bridgeId": "1000f60d",
      "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2",
      "statusV2": {
        "cloudConnectionStatus": "connected",
        "edgeReportedDeviceStatus": "operational",
        "deviceSpecificError": "generalDeviceError"
      },
      "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"
      ]
    }
  ]
}