Event Search Webservice

Get normal seekpoint events and access control seekpoint events

Get normal seekpoint events and access control seekpoint events

post/api/eventSearch/getEventSeekpoints

Request

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

Set of activity types to filter seekpoints by

durationSecinteger nullable

Duration in seconds for the search window

startTimeSecinteger nullable

Start time in seconds for the search window

Example request

{
  "componentSeekPointsByAccessControlledDoorWSRequest": {
    "accessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "componentSeekPointsByAccessControlledDoorsWSRequest": {
    "accessControlledDoorUuidList": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "componentSeekPointsByOwnerDeviceWSRequest": {
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "durationSec": 3600,
  "searchColorAndVehicleByColorWSRequest": {
    "deviceFilter": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "endTimeMs": 1641081600000,
    "startTimeMs": 1640995200000
  },
  "searchMotionGridWithActivitiesWSRequest": {
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "endTimeUtcSecs": 1641081600,
    "searchCells": [
      {
        "col": 5,
        "row": 3
      }
    ],
    "startTimeUtcSecs": 1640995200
  },
  "seekpointsWSRequest": {
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
  },
  "startTimeSec": 1640995200,
  "videoFootageWSRequest": {
    "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "cameraUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "duration": 3600,
    "includeAnyMotion": true,
    "startTime": 1640995200,
    "useMultiCamera": true
  }
}

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.