Documentation for Face PSIM 2.0.

Previous page Next page

General request format:

POST http://AxxonPSIM_user_login:AxxonPSIM_user_password@IP address:port/firserver/FindPasserBy

Request parameters:

ParameterRequiredParameter description
server_idYesIdentifier of the face recognition server in Face PSIM
dataYesData that you want to get
cameraIdsNoCamera identifiers (ID). If you don't specify them, the results by all cameras are displayed
dateTimeFromYesTime in UTC+0 format starting from which the face search is performed
dateTimeToYes

Time in UTC+0 format up to which the face search is performed

simNoSimilarity level between the face from the camera photo and the reference image in the request is in the range from 0 to 1. The recommended value is 0.8
imageYesJPEG image in base64 format

Request example:

POST http://1:1@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 the request
Content-LengthShows the size of characters 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-OriginShows if the server response can be accessed by the code that sends a request from this source
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 the face accesses captured by cameras
idIdentifier of the user from the faces database
sim

Similarity level between the face in the camera photo and the reference image in the request. The received results must be equal or greater than the specified value

cameraIdID of the camera that captured the face
timestampTime of face capture/access in UTC+0 format
totalCountNumber of the face accesses
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