Page History
General request format:
POST http://
...
IP-address:
...
port/firserver/GetProtocols
JSON parameters and response example:
Request parameters:
| Parameter | Required | Parameter description |
|---|---|---|
| server_id | Yes | ID of the Face Recognition Server in the Face-Intellect software package |
onlineRefresh | Yes | This parameter must be set to 1 |
genders | No | Gender: 0 - unknown, 1 - male, 2 - female If not specified, gender is not taken into account |
| page | No | Number of results pages If not specified, then page = 1 |
pageSize | No | Results per page If not specified, then pageSize = 1, i.e. there will be 1 result on 1 page |
| cameraIds | No | Camera IDs (GUID or ID in the Intellect object tree) If not specified, then results for all cameras are displayed |
| sim_min | No | Face types: -1 - all faces, 1 - only recognized, 0 - only unrecognized If not specified, then sim_min = -1 |
| minAge | No | Minimum age of persons If not specified, age is not taken into account |
| maxAge | No | Maximum age of persons If not specified, age is not taken into account |
| dateTimeFrom | Yes | The initial boundary of the time period in UTC format: yyyy-mm-ddThh:nn:ss.fff |
| dateTimeTo | Yes | Ending boundary of the time period in UTC format: yyyy-mm-ddThh:nn:ss.fff |
Request example:
POST http://localhost:10000/firserver/GetProtocols
| Expand | ||
|---|---|---|
| Code Block | ||
POST /firserver/GetProtocols HTTP/1.1
Host: localhost:10000
Content-Type: application/json
Cache-Control: no-cache
Postman-Token: e173f0b5-ed8d-649e-e4a3-5f751568f236
|
where:
- server_id - ID of the Face Recognition Server in the Face-Intellect software package (see the Configuring the Face Recognition Server object)
- onlineRefresh - this parameter must be set to 1
- genders - 0 - unknown, 1 - male, 2 - female
- page, pageSize - paging parameters
- cameraIds - camera IDs (GUID or the ID in the Intellect object tree)
- sim_min - face types: -1 - all faces, 1 - only recongnized, 0 - only unrecognized
- minAge, maxAge - age filter
- dateTimeFrom, dateTimeTo - time filter in UTC format yyyy-mm-ddThh:nn:ss.fff.
Example of response with the recognized face:
Response example:
| Expand | ||
|---|---|---|
|
...
Response parameters:
| Parameter |
|---|
...
| Parameter description | |
|---|---|
| id | Identifier of the captured image |
...
| camera_id |
...
| Identifier of the camera that captured the face |
...
| camera_name |
...
| Name of the camera that captured the face; | |
| timestamp |
...
| Face capture time in UTC format |
...
| age |
...
| Age of face |
...
| gender |
...
Gender: |
...
0 - unknown |
...
, 1 - male |
...
, 2 - female |
...
| ethnicity | Ethnicity: |
...
0 - unknown |
...
, 1 - Mongoloid race |
...
, 2 - Negroid race |
...
, 3 - Caucasian race |
...
, 4 - East Indian race |
...
| emotion | Emotion: |
...
0 - unknown |
...
, 1 - anger |
...
, 2 - fear |
...
, 3 - joy |
...
, 4 - without emotion |
...
, 5 - sadness |
...
, 6 - surprise |
...
| glasses | Glasses: |
...
0 - unknown |
...
, 1 - dark glasses |
...
, 2 - no glasses |
...
, 3 - ordinary |
...
| facialHair | Facial Hair: |
...
0 - unknown |
...
, 1 - beard |
...
, 2 - bristles |
...
, 3 - goatee and mustache |
...
, 4 - goatee |
...
, 5 - mustache |
...
, 6 - no facial hair |
...
| hairColor | Hair Color: |
...
0 - unknown |
...
, 1 - brunette |
...
, 2 - blond |
...
, 3 - brown |
...
, 4 - red |
...
, 5 - gray |
...
| hairType |
...
Type of bald head: |
...
0 - unknown |
...
, 1 - bald |
...
, 2 - with a receding hairline |
...
, 3 - no baldness |
...
| headwear | Headwear: |
...
0 - unknown |
...
, 1 - cap |
...
, 2 - bandana |
...
, 3 - beret |
...
, 4 - hat |
...
, 5 - hat with earflaps |
...
, 6 - fur hood |
...
, 7 - glasses |
...
, 8 - hat |
...
, 9 - helmet |
...
, 10 - hood |
...
, 11 - cloth cap |
...
, 12 - scarf |
...
, 13 - no headwear |
...
, 14 - peaky cap |
...
| liveness | Liveness - fake face: |
...
0 - unknown |
...
, 1 - no |
...
, 2 - yes |
...
| evasion | Evasion - concealment of the face: |
...
0 - unknown |
...
, 1 - no |
...
, 2 - mask |
...
, 3 - dark glasses |
...
, 4 - face overlap |
...
| temperature | Temperature - face temperature in degrees Celsius |
...
| fir | Face vector data |
| data | Face pattern (vector) |
| engine | |
| alg | The used face recognition and search algorithm: 0 - ALG1, 1 - ALG2, 2 - PRECISE |
| Hits | The recognized face information from the faceDB and intellect databases. If the face is not recognized, the field will be empty |
...
| id |
...
The identifier of the image from the reference face database |
...
| person_id |
...
The identifier of the corresponding user in Intellect |
...
| sim |
...
Similarity rate of the captured face with the image from the reference face database |
...
| timestamp | Timestamp - time of receiving the image with the captured face |
...
| surname |
...
Last name |
...
| name |
...
First name | |
| patronymic | Patronymic name |
| comment | Comment |
| department | Department |