View Source

General request format:

POST http://AxxonPSIM_user_login:AxxonPSIM_user_password@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	ID of the Axxon PSIM user If not specified, the response returns information about all users
page	No	Number of pages with results If not specified, then page = 1
pageSize	No	Number of results per page If not specified, then pageSize = 1, that is, there is one result on one page
departmentFilter	No	ID of the department

Request example:

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

Get information about users from the entire face database

{
 "server_id": "1",
 "objectType": "PERSON",
 "id": [
 
 ],
 "page": 1,
 "pageSize": 2
}

Get information about users from a specified department

{
 "server_id": "1",
 "departmentFilter":"1"
 "objectType": "PERSON",
 "id": [
 
 ],
 "page": 1,
 "pageSize": 2
}

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	Shows if the server response can be accessed by the code that sends a request from this source
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"
 }

The response returns users in the order of when they were added to the database (most recently added first).

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

Response parameters:

Parameter	Parameter description
PersonList	List of users with information from the face database
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 database of reference faces in UTC+0 format
ImageId	Identifier of the reference face image from the face database
AutoCreated	true if the unrecognized face is added automatically
LastRecognitionTimestamp	Time of the last access in UTC+0 format
RecognitionCount	Number of accesses
Total	Total users in the face database
Source	ID of the server in GUID format
Response	Response
Status	Status of the completed request: OK—successful, if error—see List of possible errors of the Face recognition server