JSON Web API GetTemplateStatus

Fetches the biometric face template status of an enrolled person, if available. Additionally the method allows to fetch the thumbnail images, used to enroll the person, if available.

Request

GET /api/face/v1/template/status/{classId}

Path Parameter

classId

The unique class ID of the requested face template.

Query Parameter

downloadThumbnails

Optional boolean flag indicating whether to fetch the thumbnail images or not. If set to true (?downloadThumbnails=true), all stored face thumbnails are returned with the response.

Request Body

This HTTP request requires no body content.

Request Headers

This API requires a valid JWT in the Authorization request header and accepts an optional reference number.

Authorization	Required Bearer authentication. Please refer to BWS API Authentication for a description of how to provide a valid JWT here.
Reference-Number	Optional, client specific reference number, which will be added to the BWS bookkeeping as well as to the response header. You typically use this reference to link the resulting BWS bookkeeping entries with your logs.

Response

Response Body

Content type: application/json

{
  "classId": 0,
  "available": true,
  "enrolled": "string",
  "tags": [
    "string"
  ],
  "encoderVersion": 0,
  "featureVectors": 0,
  "thumbnailsStored": 0,
  "thumbnails": [
    {
      "enrolled": "string",
      "image": "string"
    }
  ]
}

On success the API returns a JSON serialized FaceTemplateStatus object.

HTTP Status Codes

The call returns one of the standard HTTP status codes, e.g.:

200 (OK)

The response body contains the FaceTemplateStatus response object as described above.

400 (Bad Request)

The call failed, typically due to an invalid argument. The response body contains a JSON object with the reported gRPC error code and message.

401 (Unauthorized)

The request does not have valid authentication credentials for the operation.

500 (Internal Server Error)

Server experienced some unexpected behaviour.

503 (Service Unavailable)

The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff.

Response Headers

All successful BWS calls return a response header containing additional information about the request:

jobid	The Job-ID (a GUID) that has been assigned to this BWS call.
bws-version	The version of the BWS gRPC service.
reference-number	An optional reference number as provided in the request header.
date	The timestamp when the request has been received at the server.
...	Other headers that might have been added by the server (NGINX, Kestrel, ...) that was handling the request.