Documentation for Face PSIM 1.0.1.

Previous page List of possible errors of the Face recognition server  Number of faces in the frame Next page

General request format:

POST http://IP address:port/firserver/FindPasserBy

Request parameters:

ParameterRequiredParameter description
server_idYesIdentifier of the Face recognition server in Face PSIM
dataYesData you want to get
cameraIdsNoCamera identifiers (ID). If they are not specified, the results for all cameras are displayed
dateTimeFromYesTime in UTC+0 format, starting from which the face search will be performed
dateTimeToYes

Time in UTC+0 format, up to which the face search will be performed

simNoLevel of similarity between the face from the camera photo and the reference image in the request in the range of 0-1. The recommended value is 0.8
imageYesImage in base64 format

Request example:

POST http://127.0.0.1:10000/firserver/FindPasserBy

{
"server_id" : "1",                                                              
"data":
{
"cameraIds" : ["1"],                         
"dateTimeFrom" : "2023-08-23T12:20:00",
"dateTimeTo" : "2023-08-25T16:20:00",
"sim" : 0.9,
"image" : "Alex's photo in base64"
}
}

Request headlines:

Headline Headline description
AllowReturns the HTTP method used in request
Content-LengthShows the size of characters in bytes, received in the request. Measured in bytes
Content-TypeReturns the type of the received request
ServerSpecifies the server from which the request comes
Access-Control-Request-MethodReturns the HTTP method that can be used in the request
Access-Control-OriginIndicates if the code that sends the request from this source can access the server response
DateShows the time of the request

Response example:

{
    "Data": {
        "rows": [
            {
                "id": "301F1817-2B43-EE11-B47A-D85ED323673C",
                "sim": 0.994588,
                "cameraID": "aaffb7ea-2743-ee11-b47a-d85ed323673c",
                "timestamp": "2023-08-25T09:38:08.027"
            },
            {
                "id": "7F1D0A07-2B43-EE11-B47A-D85ED323673C",
                "sim": 0.993709,
                "cameraID": "aaffb7ea-2743-ee11-b47a-d85ed323673c",
                "timestamp": "2023-08-25T09:37:47.249"
            },
            {
                "id": "CA87811E-2B43-EE11-B47A-D85ED323673C",
                "sim": 0.993194,
                "cameraID": "aaffb7ea-2743-ee11-b47a-d85ed323673c",
                "timestamp": "2023-08-25T09:38:18.267"
            }
        ],
        "totalCount": 3,
        "duration": 127
    },
    "Status": "OK"
}

Response parameters:

ParameterParameter description
DataReceived data
rowsList of passages of the face captured by the cameras
idIdentifier of the user from the faces database
sim

Level of similarity between the face in the camera photo and the reference image in the request. The results must be equal to or greater than the specified value

cameraIdID of the camera that captured the face
timestampTime of face capture/passage in UTC+0 format
totalCountNumber of passage of the face
durationFace processing time in milliseconds
StatusStatus of the executed request: SUCCESS—successful, if error—see List of possible errors of the Face recognition server
  • No labels