Get the lock list of an account

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

List locks added by you，no matter it is added by Sciener APP or added by APP SDK and initialized by cloud API: Lock init

If your locks were added by Sciener APP，request this API with the access token get with the username and password of the user account you login Sciener APP.

If your locks were initialized by cloud API:Lock init, request with the same access token when init the lock.

This API will only return locks which you are top administrator. Ekeys others shared to you can be queried by cloud API: ekey list.

If integrated with TTHotel, this API can also retrieve lists of power savers or lift controls. Simply add the parameter 'type': type = 1 for lock list, type = 2 for lift control list, and type = 3 for power saver list.

1 Request example

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


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

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
lockAlias	String	N	Search by lock alias, fuzzy matching
groupId	Int	N	Group ID，search by group, refer to: Add group for detail
pageNo	Int	Y	Page no, start from 1
pageSize	Int	Y	Items per page, default 20, max 1000
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, default 20, max 10000
pages	Int	Total number of pages
total	Int	Total number of records

The objects in the list

Parameter	Type	Description
lockId	Int	Lock ID, generated by Lock init
lockName	String	Lock name
lockAlias	String	Lock alias
lockMac	String	Lock MAC
electricQuantity	Int	Lock battery
featureValue	String	characteristic value. it is used to indicate what kinds of feature do a lock support.
hasGateway	Int	Is the lock binded to gateway:1-yes, 0-no
lockData	String	Lock data, used to operate the lock
groupId	Int	Group id
groupName	String	Group name
date	Long	Lock init time (timestamp in millisecond)


xxxxxxxxxx
21
1
{
2
    "list": [
3
        {
4
            "lockId": 532323,
5
            "lockName":"YS1003_c18c9c",
6
            "lockAlias":"Front door lock",
7
            "lockMac": "C5:40:E0:9C:8C:C1",
8
            "electricQuantity": 55,
9
            "featureValue":"3F0421C4F5F3",
10
            "hasGateway": 1,
11
            "lockData": "xxxxxxxxxxxxx",
12
            "groupId": 456,
13
            "groupName": "The 4th floor",
14
            "date": 1528878944000,
15
        }
16
    ],
17
    "pageNo":1,
18
    "pageSize":20,
19
    "pages":1,
20
    "total":1
21
}