Get Palm vein list of a lock

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

1 Request method and example

POST, ContentType:application/x-www-form-urlencoded


xxxxxxxxxx
7
1
curl --location -g --request POST 'https://api.sciener.com/v3/palmVein/list'\
2
--data-urlencode 'clientId=4773aa036f7f49c68d876bb4be85c80c' \
3
--data-urlencode 'accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f' \
4
--data-urlencode 'lockId=3466252' \
5
--data-urlencode 'pageNo=1' \
6
--data-urlencode 'pageSize=10' \
7
--data-urlencode '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	id of a lock
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
id	Int	id of a palm vein
name	String	name of a palm vein
number	String	number of a palm vein
status	String	Status: 1-normal, 2-invalid, 3-pending
nickname	String	nickname of creator
startDate	Long	The time when it becomes valid (timestamp in millisecond)
endDate	Long	The time when it is expired (timestamp in millisecond)
type	Int	Type：1-Normal、4-Recurring
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	Creation time

cyclicConfig：

Parameter	Type	Description
startTime	Int	The time when it becomes valid, in minute, for example 480 for 8:00
endTime	Int	The time when it becomes validit is expired, in minute, for example 1080 for 18:00
weekDay	Int	Week day：1-7, 1-Monday, 2-Tuesday...7-Sunday


xxxxxxxxxx
19
1
{
2
    "list": [
3
        {
4
            "id": 34242,
5
            "type": 1,
6
            "number":50432139657219,
7
            "name": "Test",
8
            "startDate": 1625025703000,
9
            "endDate": 1665025703000,
10
            "status": 1,
11
            "createDate": 1625025703000,
12
            "nickname": "landlord2",
13
        }
14
    ],
15
    "pageNo":1,
16
    "pageSize":10,
17
    "pages":1,
18
    "total":1
19
}