Face Recognition Event Webservice

Update face event

Update face event.

post/api/faceRecognition/faceEvent/updateFaceEvent

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/faceRecognition/faceEvent/updateFaceEvent
  • 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

eventUuidstring RUUID nullable

base 64 (url-safe) uuid string

personNamestring nullable

Name of the person associated with the face event. Ignored if person UUID matches to one of the top person matches.

personUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "eventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "personUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

Example response

{
  "faceEvent": {
    "detectionConfidence": 0.98,
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "embeddingConfidence": 0.95,
    "eventTimestamp": 1640995200000,
    "hasEmbedding": true,
    "imageS3Key": "face-events/images/event_123.jpg",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "personUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "selectedPersonMatch": {
      "confidence": 0.95,
      "faceId": "face_12345",
      "name": "John Doe",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "thumbnailS3Key": "face-events/thumbnails/event_123.jpg",
    "topPersonMatches": [
      {
        "confidence": 0.95,
        "faceId": "face_12345",
        "name": "John Doe",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

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