|
|
ekey list
https://api.sciener.com/v3/key/list
Add a request parameter: sdkVersion=2, when using SDKV2 or WxTTLockPlugin
1. Description
| Name |
Type |
Required |
Description |
| clientId |
String |
Y |
The app_id which is assigned by system when you create an application |
| accessToken |
String |
Y |
Access token |
| lockAlias |
String |
N |
Search by lock alias, fuzzy matching |
| groupId |
Int |
N |
Group id |
| pageNo |
Int |
Y |
Page, start from 1 |
| pageSize |
Int |
Y |
Items per page, default 20, max 10000 |
| date |
Long |
Y |
Current time (timestamp in millisecond) |
2.Response
| Parameter |
Type |
Description |
| keyId |
Int |
ekey ID |
| lockData |
String |
Lock data, used to operate lock |
| lockId |
Int |
Lock ID |
| userType |
String |
ekey type:110301-admin ekey, 110302-common user ekey |
| keyStatus |
String |
ekey status, reference:/doc/api/keyStatus |
| lockName |
String |
Lock name |
| lockAlias |
String |
Lock alias |
| lockMac |
String |
Lock MAC |
| noKeyPwd |
String |
Super passcode, which only belongs to the admin ekey, can be entered on the keypad to unlock |
| deletePwd |
String |
Erasing passcode,which belongs to old locks, has been abandoned. Please don't use it. |
| electricQuantity |
Int |
Lock battery |
| lockVersion |
JsonObject |
Lock version |
| startDate |
Long |
The time when it becomes valid, timestamp in milliseconds |
| endDate |
Long |
The time when it is expired, timestamp in milliseconds |
| remarks |
String |
Comment |
| keyRight |
Int |
Is key authorized:0-NO,1-yes |
| keyboardPwdVersion |
Int |
Passcode version: 0、1、2、3、4 |
| specialValue |
Int |
characteristic value. it is used to indicate what kinds of feature do a lock support. |
| remoteEnable |
Int |
Is remote unlock enabled: 1-yes,2-no |
| groupId |
Int |
Group id |
| groupName |
String |
Group name |
Parameter in lockVersion object
| Parameter |
Type |
Description |
| protocolType |
Int |
Protocol type |
| protocolVersion |
Int |
Protocol version |
| scene |
Int |
Scene |
| groupId |
Int |
ClientID |
| orgId |
Int |
ClientSubID |
|