Versions Compared

Key

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

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

ParameterRequiredParameter description
server_idYes

ID of the Face Recognition Server in the Face-Intellect software package (see the Configuring the Face Recognition Server object)

idNoIf empty, the response will return all users' info with paging
pageNo

pageSize

No

Example request:

POST http://localhost:10000/firserver/ReadPersonsJSON parameters:

Expand


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

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

where 

  • server_id - ID of the Face Recognition Server in the Face-Intellect software package (see the Configuring the Face Recognition Server object)
  • id - if empty, the response will return all users' info with paging
  • page, pageSize - paging parameters.

Example of response:


Sample answer:

Expand


Code Block
{
 "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,
 "Responce": {
 "Status": "OK"
 
}
}

where:  

  • PersonList.ImageId - image ID


...

titleNote

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

...

titleNote

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

ParameterParameter description
PersonList
id
name
surname
patronymic
department
comment
timestamp
ImageId
Total
Responce
Status