Camera Webservice

Get custom footage seekpoints V2

Get activity seekpoints for specified camera

post/api/camera/getCustomFootageSeekpointsV2

Request

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

customDescriptionstring nullable

Filters which custom footage seek point to search for by description

customDisplayNamestring nullable

Filters which custom footage seek point to search for by name

deviceUuidsstring[] nullable

List of device UUIDs to filter the search

durationinteger nullable

How far from the start timestamp to search in seconds

locationUuidsstring[] nullable

List of location UUIDs to filter the search

startTimeinteger nullable

Starting timestamp of the search in UNIX seconds

Example request

{
  "customDescription": "Motion detected in camera view",
  "customDisplayName": "motion_event",
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "duration": 3600,
  "locationUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "startTime": 1640995200
}

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

{
  "customFootageSeekPoints": [
    {
      "compositComponentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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