Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General request format:

POST http://

...

IP-address:

...

port/firserver/GetProtocols

...

Request parameters:

...

Code Block
{
 "server_id": "1",
 "onlineRefresh": 1,
 "genders": [
 0,
 1,
 2
 ],
 "dateTimeFrom": "2017-05-11T16:25:55.687",
 "dateTimeTo": "2017-05-12T16:26:55.687",
 "cameraIds": [
 "1",
 "2"
 ],
 "minAge": 0,
 "maxAge": 1000,
 "page": 1,
 "pageSize": 2,
 "sim_min": -1
}

where:

...

ParameterRequiredParameter description
server_idYes

ethnicityID of the Face Recognition Server in the Face-Intellect software package

...

onlineRefresh 

Yes

This

...

parameter must be set to 1

genders

...

No

Gender: 0 -

...

undefined,

...

1 - male, 2 - female

If not specified, gender is not taken into account

pageNo

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

cameraIdsNo

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

minAgeNo

Minimum age of persons

If not specified,

...

age is not taken into account

maxAgeNo

Maximum age of persons

If not specified, age is not taken into account

dateTimeFromYesThe initial boundary of the time period in UTC format: yyyy-mm-ddThh:nn:ss.fff

...

dateTimeToYesEnding boundary of the time period in UTC format: yyyy-mm-ddThh:nn:ss.fff

Request example:

POST http://127.0.0.1:10000/firserver/GetProtocols

Code Block

Example of request:

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

{
  "server_id": "1",
  "onlineRefresh": 1,
  "genders": [
    0,
    1,
    2
  ],
  "dateTimeFrom": "20172020-05-11T1614T16:25:55.687",
  "dateTimeTo": "20182020-05-12T1616T16:26:55.687",
  "cameraIds": [
    "1"
  ],
  "minAge": 0,
  "maxAge": 1000,
  "page": 1,
  "pageSize": 50,
  "sim_min": -1
}

 

...

Response example:

Code Block
{
    "Protocols": [
        {
            "id": "E0E4A8BA18D10CC2-11379596-E711EA11-9E4B8A9A-9C5C8E763A8FB06EBF8119EF",
            "camera_id": "15",
            "camera_name": "Cameragrundig 15",
            "timestamp": "20172020-05-12T1215T10:5120:3654.427657",
            "age": 4755.94944815,
            "gender": 12,
    "Hits        "emotion": [
 {
 "id": "B38CCB8F-1137-E711-9E4B-9C5C8E763A8F",
 "sim": 0.589775,
 "timestamp": "2017-05-12T12:50:28.307",
 "surname": "liam",
 "name": "neeson",
 "patronymic": "",
 "comment": "",
 "department": "Department 1"
 }
 ]
 },
 {
 "id": "C4B585B4-1137-E711-9E4B-9C5C8E763A8F",
 "camera_id": "1",
 "camera_name": " Camera 1",
 "timestamp": "2017-05-12T12:51:34.951",
 "age": 24.9269,
 "gender": 1,
 "Hits": [
 {
 "id": "718CCB8F-1137-E711-9E4B-9C5C8E763A8F",
 "sim": 0.691023,
 "timestamp": "2017-05-12T12:50:27.950",
 "surname": "jude",
 "name": "law",
 "patronymic": "",
 "comment": "",
 "department": "Department 1"
 }
 ]
 }
 ],
 "ProtocolsTotal": 34,
4,
            "glasses": 2,
            "facialHair": 6,
            "hairColor": 1,
            "hairType": 3,
            "headwear": 13,
            "liveness": 1,
            "evasion": 1,
            "temperature": 36.6,
            "fir": {
                "data": "rvOGvR0Oxbx76+a8kIHXPfbzkbwY7hA9vpS5PRdb0j32pg4+yqerPT6Ghjw/Vhy9PpMQvWHqmb2U5VQ8kic/vWIS/b0xXNq8kJ7hPU7MGT2qdxw9FdAJPFXwtLxGLUQ9wBJCPLPiB71UMoU8vhbHPOThqb3VaSg92qH0PHOj1zyEdaa9ulOxvVfWq71oyOo8twbWu3g+mD0SQvw8C/KhvEjElrspZFi9Q7xsu6FLoL1mLa492n3tvCyBl7wNLl8+n+6RvRQnCbzDDhw9EnCAPdSsmT2PsHa8n+6HvTd6Cj0qT3U9oFQMveIDNj0m7sU8eih0vYGvgT3INIc9tWfXvevQnr1QMmG92WGHvf7Ulzxz74a8aCmlvXAa6j0vEMO8ApXTvGsowLwOuzC9TpGtO0eUfbzBOF4+SUgqPQpEvbyr+K08NJQTve1zZLrt6kQ9lvwEvZCE/j0R9B693z+APJK7l7x6K+W9yPTmO8ai1jp630U9OKUUPujXET0WnPa8DIW7PE32Z73Fkke8kYNmvZg/Lb2bv+o95BUKvYRH47yr70S8ojApvaMX5bwC4Co9AuwNvSFoWTyaXa09ueWFvPZ+RT3w7Mk7HnsLvDsmBD32PAW9IuphvSZLpTyBN5W9+e4sPcuAXr2RNI288I5hvYAm3LtEHnm9FFVFvIo8VL0ishw+QHjDPGGbhr2sJZK8E3a5PYsDK73kgKu8cN4/PB3Z8z10AE+9HWm7PRJhdr5l7Tm9LjRHvZtTA7wTW+08nGa4PXmX0bs1mwk8xrGcPBgNfzyfF7A6vYPWPaRxUL3jK8e7Y3KOvX5i77z543o9Xh/9PF0eAD24hrG8VYl1vRQnhrxGpcm8uuOCOdmlAz0z2AG+0cCHu6l/Yz1XdlA9fHPnvAZuij2dv9g7hlbYu47LJb1fUFM9IpIcvSRgBr7RC4Y9GgFCPeuYTLyw2oe9wUZNPZAPGr0GlEK96x2nvY29ybyQdZE9/v4jvcPhXbu9D309YWkWPYfTTD4S3fc9BtZqu3cfMLydFbu9IgSjO1PYMjx0rUA9Z1qgvSmWSj3BBlm8DcuvPWBNHr0eOYA9r5eIPMbslL26mIi852wHPvVfOD1wWPk8gHECvSVsgr3bM7i9GNleu+Lbfj0UDY29VU0hvv3xUzxaiAY9DtccPfk+BD0M+iy9IZABvRr35DzOpsy9G7VWPVmkoD26GAE9JBptvbtnL73QTFA9+fs3veiXx7v76o09m130O4OzRT3zog09YTimvAlnO71mTac8BPmCPcVQ8LzJ/yY9EdYUPSJpc704YWA9OCaRvRmzOr6bnjg7vLHWPBcI0ryxdKq8WsZ9PIINOD00RzO9MVeIuw==",
                "engine": 3,
                "alg": 0
            },
            "Hits": [
                {
                    "id": "A5204509-9596-EA11-8A9A-B06EBF8119EF",
					"person_id": "2",
                    "sim": 0.249181,
                    "timestamp": "2020-05-15T10:15:44.807",
                    "surname": "Doe",
                    "name": "John",
                    "patronymic": "White",
                    "comment": "Senior developer",
                    "department": "IT department"
                }
            ]
        }
    ],
    "ProtocolsTotal": 1,
    "Status": "OK"
}

...

Response parameters:

...

ParameterParameter description
idIdentifier of the captured image
camera_idIdentifier of the camera that captured the face
camera_nameName of the camera that captured the face;
timestamp Face capture time in UTC format
ageAge of face
gender 

Gender: 0 - undefined, 1 - male, 2 - female

emotion

Emotion: 0 - undefined, 1 - rage, 2 - fear, 3 - happiness, 4 - without emotion, 5 - sadness, 6 - astonishment

glasses

Glasses: 0 - undefined, 1 - tinted glasses, 2 - without glasses, 3 - glasses

facialHair

Facial hair: 0 - undefined, 1 - beard, 2 - bristle, 3 - imperial beard and mustache, 4 - imperial beard, 5 - mustache, 6 - absent

hairColor

Hair color: 0 - undefined, 1 - brunet, 2 - blonde, 3 - chestnut hair, 4 - ginger, 5 - gray

hairType

Type of bald head: 0 - undefined, 1 - bald, 2 - with receding hairline, 3 - without bald head

headwear

Headwear: 0 - undefined, 1 - cap, 2 - bandana, 3 - beret, 4 - beanie, 5 - trapper hat, 6 - fur hood, 7 - glasses on head, 8 - hat, 9 - helmet, 10 - hood, 11 - kepi, 12 - headscarf, 13 - without headwear, 14 - peaky cap

liveness

Artificial face: 0 - unknown, 1 - no, 2 - yes

evasion

Face concealment: 0 - unknown, 1 - no, 2 - mask, 3 - dark glasses, 4 - face overlap

temperature

Temperature - face temperature in degrees Celsius

firFace vector data
dataFace pattern (vector)
engineThe used SDK: 1 - Cognitec, 2- VISIONLABS, 3 - TEVIAN, 4 - STC, 5 - external (Huawei)
algThe 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

...