General request format:

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

Request parameters:

ParameterRequiredParameter description
server_idYes

ID of the Face Recognition Server in the Face-Intellect software package

idNo

Intellect user ID

If not specified, the response will return information about all users

pageNo

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 example:


{
 "PersonList": [
 {
 "Id": "188ECB8F-1137-E711-9E4B-9C5C8E763A8F",
 "Name": "Friske",
 "Surname": "Jeanna",
 "Patronymic": "",
 "Department": "Department 1",
 "Comment": "",
 "Timestamp": "2017-05-12T12:50:30.378",
 "ImageId": "1B8ECB8F-1137-E711-9E4B-9C5C8E763A8F"
 },
 {
 "Id": "148ECB8F-1137-E711-9E4B-9C5C8E763A8F",
 "Name": "Smath",
 "Surname": "William",
 "Patronymic": "",
 "Department": "Department 1",
 "Comment": "",
 "Timestamp": "2017-05-12T12:50:30.368",
 "ImageId": "158ECB8F-1137-E711-9E4B-9C5C8E763A8F"
 },
 {
 "Id": "198ECB8F-1137-E711-9E4B-9C5C8E763A8F",
 "Name": "Snipes",
 "Surname": "Wesley",
 "Patronymic": "",
 "Department": "Department 1",
 "Comment": "",
 "Timestamp": "2017-05-12T12:50:30.358",
 "ImageId": "1A8ECB8F-1137-E711-9E4B-9C5C8E763A8F"
 }
 ],
 "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:

ParameterParameter description
PersonListList of users with information from the database of persons
idUser identifier from the face database
nameName
surnameSurname
patronymicPatronymic
departmentDepartment
commentComment
timestampTime of adding a face to the base of reference faces in UTC format
ImageIdReference face image identifier from the face database
TotalTotal users in the face database
ResponseResponse
StatusCompleted request status: OK - successful