Get the face list of a lock

https://api.sciener.com/v3/face/list

List all face that added to the lock.

1 Request example


xxxxxxxxxx
curl --location -g --request GET 'https://api.sciener.com/v3/face/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&pageNo=1&pageSize=20&date=1625025703000'

2 Request parameters

Name	Type	Required	Description
clientId	String	Y	client_id from Create application
accessToken	String	Y	Access token，refer to: Get access token
lockId	Int	Y	Lock ID, generated by Lock init
searchStr	String	N	Search string (name fuzzy matching)
pageNo	Int	Y	Page no, start from 1
pageSize	Int	Y	Items per page，max 200
date	Long	Y	Current time (timestamp in millisecond)

3 Response and example

Parameter	Type	Description
list	JSONArray	list of records
pageNo	Int	Page no, start from 1
pageSize	Int	Items per page, max 200
pages	Int	Total number of pages
total	Int	Total number of records

The objects in the list

Parameter	Type	Description
faceId	Int	Face ID
lockId	Int	Lock ID
name	String	Face name
faceNumber	String	Face number
status	String	Status: 1-normal、2-Invalidated、3-To be validated
nickname	String	Creator name
userid	String	Creator Uid
type	Int	Face type: 1-normal、4-recurring
startDate	Long	The time when it becomes valid (timestamp in millisecond)
endDate	Long	The time when it is expired (timestamp in millisecond)
cyclicConfig	JSONArray	Recurring time period, the valid time period of each week day must be the same, for example: `[{"weekDay":1, "startTime":480,"endTime":1080},{"weekDay":2, "startTime":480,"endTime":1080}]` for valid from 8:00 to 18:00 in Monday and Tuesday.
createDate	Long	Create time (timestamp in millisecond)


xxxxxxxxxx
{
    "list": [
        {
            "faceId": 224242,
            "lockId": 163377,
            "faceNumber": "44668054142981",
            "faceType": 1,
            "faceName":"face",
            "startDate": 1625025703000,
            "endDate": 1645025703000,
            "createDate": 1625025703000,
            "nickname": "alexa@google.com"
        }
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}