Versions Compared

Key

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

POST http://localhost:10000/firserver/GetProtocols

JSON parameters and response example:

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": "20172020-05-12T1616T16:26:55.687",
  "cameraIds": [
    "1",
 "2"
 ],
  "minAge": 0,
  "maxAge": 1000,
  "page": 1,
  "pageSize": 250,
  "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, - 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 requestresponse with the recognized face:

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{
    "Protocols": [
        {
            "id": "18D10CC2-9596-EA11-8A9A-B06EBF8119EF",
            "camera_id": "15",
         "onlineRefresh": 1,
  "genderscamera_name": [
    0"grundig 5",
    1,
    2
  ],
  "dateTimeFromtimestamp": "20172020-05-11T1615T10:2520:5554.687657",
            "dateTimeToage": "2018-05-12T16:26:55.687"4815,
   "cameraIds": [
    "1"
  ],
  "minAgegender": 02,
            "maxAgeethnicity": 10003,
            "pageemotion": 14,
            "pageSizeglasses": 502,
     "sim_min": -1
}

 

Example of response:

Code Block
{
 "Protocols": [
 {
 "id": "E0E4A8BA-1137-E711-9E4B-9C5C8E763A8F",
 "camera_id": "1",
 "camera_name": "Camera 1",
 "timestamp": "2017-05-12T12:51:36.427",
 "age": 47.9494,
 "gender       "facialHair": 6,
            "hairColor": 1,
            "hairType": 3,
            "headwear": 13,
            "liveness": 1,
 "Hits": [
 {
 "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,
            "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": "718CCB8FA5204509-11379596-E711EA11-9E4B8A9A-9C5C8E763A8FB06EBF8119EF",
                    "sim": 0.691023249181,
                    "timestamp": "20172020-05-12T1215T10:5015:2744.950807",
                    "surname": "judeDoe",
                    "name": "lawJohn",
                    "patronymic": "White",
                    "comment": "Senior developer",
                    "department": "DepartmentIT 1department"
                }
            ]
        }
    ],
    "ProtocolsTotal": 341,
    "Status": "OK"
}

where:

  • Protocols.id - captured image IDHits.id - recognized image IDidentifier 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:
    • 0 - unknown;
    • 1 - male;
    • 2 - female;
  • ethnicity:
    • 0 - unknown;
    • 1 - Mongoloid race;
    • 2 - Negroid race;
    • 3 - Caucasian race;
    • 4 - East Indian race;
  • emotion:
    • 0 - unknown;
    • 1 - anger;
    • 2 - fear;
    • 3 - joy;
    • 4 - without emotion;
    • 5 - sadness;
    • 6 - surprise;
  • glasses:
    • 0 - unknown;
    • 1 - dark glasses;
    • 2 - no glasses;
    • 3 - ordinary;
  • facialHair:
    • 0 - unknown;
    • 1 - beard;
    • 2 - bristles;
    • 3 - goatee and mustache;
    • 4 - goatee;
    • 5 - mustache;
    • 6 - no facial hair;
  • hairColor:
    • 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:
    • 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 - fake face:
    • 0 - unknown;
    • 1 - no;
    • 2 - yes;
  • evasion - concealment of the face:
    • 0 - unknown;
    • 1 - no;
    • 2 - mask;
    • 3 - dark glasses;
    • 4 - face overlap;
  • temperature - face temperature in degrees Celsius;
  • Hits - the recognized face information from the faceDB database. If the face is not recognized, the field will be empty:
    • id - the identifier of the image from the reference face database;
    • sim - similarity rate of the captured face with the image from the reference face database;
    • timestamp - time of receiving the image with the captured face;
    • surname - last name;
    • name - first name;
    • patronymic - patronymic name;
    • comment - comment;
    • department - department.