Page History

General request format:

POST http://

...

IP-address:

...

port/firserver/GetProtocols

...

Request parameters

...

:

...

Parameter	Required	Parameter description
server_id	Yes	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
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://127.0.0.1:10000/firserver/GetProtocols

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": "2020-05-14T16:25:55.687",
  "dateTimeTo": "2020-05-16T16:26:55.687",
  "cameraIds": [
    "1"
  ],
  "minAge": 0,
  "maxAge": 1000,
  "page": 1,
  "pageSize": 50,
  "sim_min": -1
}

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:

{
    "Protocols": [
        {
            "id": "18D10CC2-9596-EA11-8A9A-B06EBF8119EF",
            "camera_id": "5",
            "camera_name": "grundig 5",
            "timestamp": "2020-05-15T10:20:54.657",
            "age": 55.4815,
            "gender": 2,
            "ethnicity": 3,
            "emotion": 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:

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

• 0 - unknown;
• 1 - Mongoloid race;
• 2 - Negroid race;
• 3 - Caucasian race;
• 4 - East Indian race;

...

• 0 - unknown;
• 1 - anger;
• 2 - fear;
• 3 - joy;
• 4 - without emotion;
• 5 - sadness;
• 6 - surprise;

...

• 0 - unknown;
• 1 - dark glasses;
• 2 - no glasses;
• 3 - ordinary;

...

• 0 - unknown;
• 1 - beard;
• 2 - bristles;
• 3 - goatee and mustache;
• 4 - goatee;
• 5 - mustache;
• 6 - no facial hair;

...

• 0 - unknown;
• 1 - brunette;
• 2 - blond;
• 3 - brown;
• 4 - red;
• 5 - gray;

...

• 0 - unknown;
• 1 - bald;
• 2 - with a receding hairline;
• 3 - no baldness;

...

• 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;

...

• 0 - unknown;
• 1 - no;
• 2 - yes;

...

• 0 - unknown;
• 1 - no;
• 2 - mask;
• 3 - dark glasses;
• 4 - face overlap;

...

...

...

...

...

...

...

...

...

...

...