Skip to content

授权管理员

授权管理员列表

  1. 请求链接: /authorizedAdmin/list

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNoStringY"1"页码
pageSizeStringY"20"每页数量
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray管理员列表
uidInt用户ID
keyStatusString钥匙状态
lockNumInt锁数量
endDateLong结束时间
nameString姓名
headUrlString头像URL
useridString用户账号
startDateLong开始时间
keyTypeInt钥匙类型
pageNoInt页码
pageSizeInt每页数量
pagesInt总页数
totalInt总数
json
{
  "list": [
    {
      "uid": 16474761,
      "keyStatus": "110402",
      "lockNum": 1,
      "endDate": 0,
      "name": "哈伦",
      "headUrl": "",
      "userid": "18682150237",
      "startDate": 0,
      "keyType": 2
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 1
}

管理员详情

  1. 请求链接: /authorizedAdmin/detail

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
uidIntY11用户ID
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
uidInt用户ID
keyStatusInt钥匙状态
lockNumInt锁数量
endDateLong结束时间
startDateLong开始时间
isRemoteUnlockInt是否支持远程开锁
nameString姓名
useridString用户账号
lockListArray锁列表
lockIdInt锁ID
lockAliasString锁别名
groupListArray分组列表
groupIdInt分组ID
nameString分组名称
lockListArray锁列表
keyIdInt钥匙ID
lockIdInt锁ID
lockAliasString锁别名
lockUserNoInt锁用户编号
json
{
  "uid": 667,
  "keyStatus": 110402,
  "lockNum": 1,
  "endDate": 1712285880000,
  "startDate": 1712026680000,
  "isRemoteUnlock": 0,
  "name": "浓浓的",
  "userid": "15099999999",
  "lockList": [
    {
      "lockId": 1759,
      "lockAlias": "HWFWYGFWGG2"
    }
  ],
  "groupList": [
    {
      "groupId": 456,
      "name": "未分组",
      "lockList": [
        {
          "keyId": 11006,
          "lockId": 1759,
          "lockAlias": "HWFWYGFWGG2",
          "lockUserNo": 0
        }
      ]
    }
  ]
}

管理员姓名/有效期/远程开锁修改

  1. 请求链接: /authorizedAdmin/update

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
uidStringY"16474761"用户ID
keyNameStringN"哈伦1"修改姓名时传入
endDateStringN"1692259259000"修改有效期传入
startDateStringN"1689577200000"修改有效期传入
remoteEnableStringN"1"是否远程开锁传入 1:打开 2:关闭
isOnlyManageSelfintN0是否仅管理自己创建的用户
keyTypeintN1钥匙类型,只支持:永久改限时
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
errorCodeInt错误码
descriptionString描述
errorMsgString错误信息
json
{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

删除授权管理员

  1. 请求链接: /authorizedAdmin/delete

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
uidStringY"16474761"用户ID
includeUnderlingsStringN"0"是否删除授权管理员发送的钥匙。1是,0否
lockIdsarrayN[100, 101]锁ID
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
errorCodeInt错误码
descriptionString描述
errorMsgString错误信息
json
{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

增加授权管理员

  1. 请求链接: /authorizedAdmin/add

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
createUserStringY"0"发送的邮箱/手机号未注册时重新调用接口加这个字段传1
endDateStringN"0"限时需传入;永久传"0"
isRemoteUnlockStringY"1"是否支持远程开锁:1-是、2-否
keyGroupIdListStringY"[503859]"分组ID列表(JSON字符串)
lockIdListStringY"[]"锁ID列表(JSON字符串)
nameStringY"15555"姓名
startDateStringN"0"限时需传入;永久传"0"
useridStringY"18682150237"用户账号(手机号/邮箱)
countryCodeStringY""国家区号(createUser=1时使用)
usernameTypeIntN11为手机号,2为邮箱(createUser=1时使用)
isOnlyManageSelfintY0是否仅管理自己发送的钥匙
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
uidInt用户ID
json
{
  "uid": 16474761
}

取消授权管理员

  1. 请求链接: /authorizedAdmin/unauthorize

  2. 请求方式: POST

说明:取消的是所有锁的管理员权限

  1. 参数说明:
名称类型是否必需示例描述
uidintY1061用户UID
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
errorCodeInt错误码
descriptionString描述
errorMsgString错误信息
json
{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success"
}

获取授权管理员下锁列表

  1. 请求链接: /authorizedAdmin/ownLockList

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
uidintY1061用户UID
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
uidInt用户ID
groupNameString分组名称
groupTypeInt分组类型
groupIdInt分组ID
lockListArray锁列表
lockIdInt锁ID
lockAliasString锁别名
json
[
  {
    "uid": 752,
    "groupName": "未分组",
    "groupType": 0,
    "groupId": 524,
    "lockList": [
      {
        "lockId": 1822,
        "lockAlias": "TMH_cf6ad1f4cbab"
      }
    ]
  }
]

鑫泓佳智能硬件通信协议文档