Page History

General request format:

POST http://IP-AxxonPSIM_user_login:AxxonPSIM_user_password@IP address:port/firserver/GetProtocols

Request parameters:

Parameter	Required	Parameter description
server_id	Yes	ID of the Face

Recognition Server

recognition server in Face PSIM
onlineRefresh	Yes	This parameter must be set to 1
genders	No	Gender:

0 — undefined, 1 — male, 2 —female

0—undefined, 1—male, 2—female

If not specified, gender is not taken into account

page

No

Number of pages with results

pages

If not specified, then page = 1

pageSize

No

Results

Number of results per page

If not specified, then pageSize = 1,

i.e. there will be 1

that is, there is one result on

1

one page
cameraIds	No	Camera IDs (GUID or ID in the Axxon PSIM

objects

object tree)

If not specified, then results for all cameras are displayed

sim_min

No

Face types: -

1 — all

1—all faces,

1 — only

1—only recognized faces,

0 — only

0—only unrecognized faces 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+0 format:

yyyy-mm-ddThh:nn:ss.fff
dateTimeTo	Yes

Ending

The end boundary of the time period in UTC+0 format: yyyy-mm-ddThh:nn:ss.fff

Request example:

POST POST http://1271:1@127.0.0.1:10000/firserver/GetProtocols

Code Block

{
  "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
}

Request headlines:

Headline	Headline description
Allow	Returns the HTTP method used in request
Content-Length	Shows the size of characters in bytes

,

received in the request
Content-Type	Returns the type of 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 if

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:

Code Block

{
    "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,
            "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",
					"person_guid": "D5E68CD2-F4D7-EB11-AC0A-B42E999B6711",
                    "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:

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

Time of the face capture

time

in UTC+0 format
age	Age of a face
gender	Gender:

0 — undefined, 1 — male, 2 — female

0—undefined, 1—male, 2—female
emotion	Emotion:

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

0—undefined, 1—rage, 2—fear, 3—happiness, 4—without emotion, 5—sadness, 6—astonishment
glasses	Glasses:

0 — undefined, 1 — tinted

0—undefined, 1—tinted glasses,

2 — without

2—without glasses,

3 — glasses

3—glasses
facialHair	Facial hair:

0 — undefined, 1 — beard, 2 — bristle

0—undefined, 1—beard, 2—bristle, 3

—

imperial beard and mustache,

4 — imperial

4—imperial beard,

5 — mustache, 6 — absent

5—mustache, 6—absent
hairColor	Hair color:

0 — undefined, 1 — brunet, 2 — blonde, 3 — chestnut hair, 4 — ginger, 5 — gray

0—undefined, 1—brunet, 2—blonde, 3—chestnut hair, 4—ginger, 5—gray
hairType	Type of bald head:

0 — undefined, 1 — bald, 2 — with

0—undefined, 1—bald, 2—with receding hairline,

3 — without

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

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

0—unknown, 1—no, 2—yes
evasion	Face concealment:

0 — unknown, 1 — face

0—unknown, 1—face not covered,

2 — mask

2—mask is on,

3 — tinted

3—tinted glasses,

4 — face

4—face partially covered,

5 — balaclava, 6 — other mask, 7 — mask is not on the right place

5—balaclava, 6—other mask, 7—mask isn't on properly
temperature	Face

temperatureTemperature — face

temperature in degrees Celsius
fir	Face vector data
data	Face

pattern

template (vector)
engine	The used SDK:

1 — Cognitec, 2 — VISIONLABS, 3 — VA, 4 — STC

1—Cognitec, 2—VISIONLABS, 3—VA, 4—STC
alg	The used face recognition and search algorithm:

0 — ALG1, 1 — ALG2, 2 — PRECISE

0—ALG1, 1—ALG2, 2—PRECISE
Hits	The recognized face information from the faceDB and Axxon PSIM databases. If the face is not recognized, the field

will be

is empty
id	The identifier of the image from the reference face database
person_id	The identifier of the corresponding user in Axxon PSIM
sim	Similarity

rate

level of the captured face with

the image

the image from the reference face database
surname	Last name
name	First name
patronymic	Patronymic

name


comment	Comment
department	Department
Status

Completed

Status of a completed request

status

:

OK — successful

OK—successful, if

error — see

error—see List of possible errors of the Face recognition server
person_guid	Identifier of the corresponding Axxon PSIM user in the GUID format

Page tree

Versions Compared

Old Version 7

New Version Current

Key