Skip to content

获取锁的钥匙列表 ​

https://cnapi.sciener.com/v3/lock/listKey

管理员或授权管理员查看这把锁上发出去的所有电子钥匙,包含通过发送钥匙生成的所有普通用户钥匙和授权管理员钥匙,该接口不返回最高管理员钥匙。

1 HTTP请求方法及示例 ​

javascript
curl --location -g --request GET 'https://cnapi.sciener.com/v3/lock/listKey?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&pageNo=1&pageSize=20&date=1625025703000'

2 参数说明 ​

名称类型是否必需描述
clientIdStringY创建应用分配的client_id
accessTokenStringY访问令牌,通过获取访问令牌接口获取
lockIdIntY锁ID,由锁初始化接口生成
searchStrStringN搜索关键词,通过钥匙名称模糊搜索
keyRightIntN钥匙是否被授权:0-否,1-是,用于过滤授权管理员电子钥匙,不传返回所有
pageNoIntY页码,从1开始
pageSizeIntY每页数量,最大200
orderByIntY排序方式:0-按名称正序、1-按生成时间倒序、2-按名称倒序
dateLongY当前时间(时间戳,单位毫秒)

3 返回参数及示例 ​

参数类型描述
listJSONArray记录列表
pageNoInt页码,从1开始
pageSizeInt每页数量,最大200
pagesInt总页数
totalInt总条数

列表中的对象

参数类型描述
keyIdInt钥匙ID
lockIdInt锁ID,由锁初始化接口生成
usernameString钥匙所有者的用户名
uidInt用户ID
keyNameString钥匙名
keyStatusString钥匙状态
startDateLong有效期开始时间(时间戳,单位毫秒)
endDateLong有效期结束时间(时间戳,单位毫秒)
keyRightInt钥匙是否被授权:0-否,1-是
remoteEnableInt是否支持远程开锁:1-是、2-否
senderUsernameString发送者用户名
remarksString备注,留言
dateLong发送时间(时间戳,单位毫秒)
{
    "list": [
        {
            "keyId": 3234293,
            "lockId": 532323,
            "username": "lock@google.com",
            "uid": 6355997,
            "keyName":"陈文亮",
            "keyStatus": "110401",
            "startDate": 1528878944000,
            "endDate": 1628878944000,
            "keyRight": 1,
            "senderUsername": "alexa@google.com",
            "remarks": "水费月底待交",
            "date": 1528878944000}
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}