General request format:
POST POST http://I addressAxxonPSIM_user_login:AxxonPSIM_user_password@IP address:port/firserver/
Request parameters:
| Parameter | Required | Parameter description |
|---|
| server_id | Yes | Identifier of the |
Face | face recognition server in Face PSIM |
| data | Yes | Data that you want to get |
| cameraIds | No | Camera identifiers ( |
GUID) from the dbo.cameras table of the Fir database. If they are not specified| ID). If you don't specify them, the results |
for | by all cameras are displayed |
| dateTimeFrom | Yes | Time in UTC+0 format |
, | starting from which the face search |
will be | is performed |
| dateTimeTo | Yes | Time in UTC+0 format |
, up to which the face search |
will be Level of similarity | Similarity level between the face from the camera photo and the reference image in the request is in the range |
of .1-| to 1. The recommended value is 0.8 |
| image | Yes |
Image | JPEG image in base64 format |
Request example:
POST http://1271:1@127.0.0.1:10000/firserver/
| Code Block |
|---|
{
"server_id" : "1",
"data":
{
"cameraIds" : ["AAFFB7EA-2743-EE11-B47A-D85ED323673C1"],
"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 |
|---|
| Allow | Returns the HTTP method used in the request |
| Content-Length | Shows the size of characters |
in bytes, | received in the request. Measured in bytes |
| Content-Type | Returns the type of the received request |
| Server | Specifies the server from which the request comes |
| Access-Control-Request-Method | Returns the HTTP method that can be used in the request |
| Access-Control-Origin |
Indicates | Shows if the server response can be accessed by the code that sends |
the | a request from this source |
can access the server response |
| Date | Shows the time of the request |
Response example:
Response example:
| Expand |
|---|
| title | Click here to expand |
|---|
|
| Code Block |
|---|
{
"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:
| Parameter | Parameter description |
|---|
| Data | Received data |
| rows | List |
of passages | of the face accesses captured by |
the | cameras |
| id | Identifier of the user from the faces database |
| sim |
Level of similarity Similarity level between the face in the camera photo and the reference image in the request. The received results must be equal |
to or greater than the specified value |
| cameraId |
GUID | ID of the camera that captured the face |
| timestamp | Time of face capture/ |
passage | access in UTC+0 format |
| totalCount | Number |
of passage | of the face accesses |
| duration | Face processing time in milliseconds |
| Status | Status of the executed request: |
SUCCESS—successful error—see
