Getting information about users

General request format:

POST http://IP-address:port/firserver/ReadPersons

Request parameters:

Parameter	Required	Parameter description
server_id	Yes	ID of the Face Recognition Server in Face PSIM
id	No	Axxon PSIM user ID If not specified, the response will return information about all users
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

Request example:

POST http://127.0.0.1:10000/firserver/ReadPersons

{
 "server_id": "1",
 "objectType": "PERSON",
 "id": [

 ],
 "page": 1,
 "pageSize": 2
}

Response 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 the code that sends the request from this source can access the server response
Date	Shows the time of the request

Response example:

"PersonList": [
	{
            "Id": "1CEE737C-B5D4-EB11-AC0A-B42E999B6711",
            "Name": "",
            "Surname": "1CEE737C-B5D4-EB11-AC0A-B42E999B6711",
            "Patronymic": "",
            "Department": "3",
            "Comment": "",
            "Timestamp": "2021-06-24T06:29:16.199",
            "ImageId": "1EEE737C-B5D4-EB11-AC0A-B42E999B6711",
            "AutoCreated": true,
            "LastRecognitionTimestamp": "2021-06-24T06:29:28.270",
            "RecognitionCount": 1,
	}
],
 "Total": 220,
 "Response": {
 "Status": "OK"
 }

Users are listed in the response in order of time of their adding to the database (last added at first).

Using the identifier from PersonList.ImageId parameter, you can get the user's photo with a separate query. See Getting image by ID.

Response parameters:

Parameter	Parameter description
PersonList	List of users with information from the database of persons
id	User identifier from the face database
name	Name
surname	Surname
patronymic	Patronymic
department	Department
comment	Comment
timestamp	Time of adding a face to the base of reference faces in UTC+0 format
ImageId	Reference face image identifier from the face database
AutoCreated	true, if the unrecognized face was added automatically
LastRecognitionTimestamp	Time of the last pass in UTC+0 format
RecognitionCount	Number of passes
Total	Total users in the face database
Response	Response
Status	Completed request status: OK - successful, if error - see List of possible errors of the Face Recognition Server

Page tree

Documentation for Face PSIM 1.0.1.