Event Search Webservice

Get camera or doorbell camera seekpoints

Get camera or doorbell camera seekpoints

post/api/eventSearch/getCameraOrDoorbellCameraSeekpoints

Request

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

activitySetActivityEnum[] nullable
deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

durationSecsinteger nullable
includeAnyMotionboolean nullable
seekpointDurationIntervalSecsinteger nullable
startTimeSecinteger nullable

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

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

{
  "combinedSeekpoints": [
    {
      "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "cardholderName": "Jane Doe",
      "customActivityDescription": "A person was detected in the camera view",
      "customActivityDisplayName": "Person Detected",
      "faceName": "John Doe",
      "licensePlate": "ABC123",
      "objectId": 12345,
      "regionMatchTimestampMs": 1640995215000,
      "seekpointEndTimeMs": 1640995300000,
      "seekpointStartTimeMs": 1640995200000,
      "stableTrackId": 42,
      "thumbnailUrl": "https://example.com/thumbnail.jpg",
      "timestampMs": 1640995200000,
      "unidentifiedFaceId": "face_12345"
    }
  ]
}

Changes

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