Face Recognition Method 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.

Service method definition

The GetTemplateStatus API is defined as a unary RPC:

rpc GetTemplateStatus (FaceTemplateStatusRequest) returns (FaceTemplateStatus);

message FaceTemplateStatusRequest {
    int64 classId = 1;
    bool download_thumbnails = 2;
}

Request

The FaceTemplateStatusRequest message has the fields as follows:

classId

The unique class ID of the requested face template.

download_thumbnails

Flag indicating whether to fetch the thumbnail images or not. If set to true, all stored face thumbnails are returned with the response.

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

On success, the API returns the FaceTemplateStatus of the generated (or existing) face template.

gRPC Errors

Besides the success return status code OK (0), this call might also return one of the following gRPC error status codes to indicate an error:

Cancelled (1)

Client application cancelled the request.

Unknown (2)

Server experienced some unexpected behavior.

InvalidArgument (3)

Client specified an invalid argument:

• A positive number is required for the class ID.

DeadlineExceeded (4)

Deadline expired before operation could complete.

Internal (13)

Internal errors indicate that critical system invariants have been violated. If you encounter one of these errors, it means something is severely wrong. These errors can occur due to an invalid service configuration, a misconfigured client, or an unexpected exception.

Unavailable (14)

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

Unauthenticated (16)

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

Response Headers/Trailers

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

Response Header
jobid	The Job-ID (a GUID) that is 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.
Response Trailer
response-time-ms	The timespan in milliseconds the request spent at the BWS service.
...	Other trailers, like exception trailers, which are added by the gRPC framework in case an RPC exception occurred.