1. 梯控授权
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
1.1 | 梯控授权分页查询 | /v1/iot/lift/liftAuthorizeControl/liftAuthorizeList | 1.0 |
1.2 | 新增梯控授权 | /v1/iot/lift/liftAuthorizeControl/addLiftAuthorize | 1.0 |
1.3 | 修改梯控授权 | /v1/iot/lift/liftAuthorizeControl/updateLiftAuthorize | 1.0 |
1.4 | 批量移除梯控授权 | /v1/iot/lift/liftAuthorizeControl/deleteLiftAuthorize | 1.0 |
1.5 | 根据梯控实例查询梯控授权用户 | /v1/iot/lift/liftAuthorizeControl/liftAuthorizeDeviceList | 1.0 |
1.6 | 梯控人脸授权 | /v1/iot/lift/liftAuthorizeControl/liftFaceAuthorize | 1.0 |
1.7 | 禁用梯控 | /v1/iot/lift/liftAuthorizeControl/switchLiftAuthorize | 1.0 |
1.8 | 根据人员授权人脸梯控 | /v1/iot/lift/liftAuthorizeControl/faceLiftAuthorizeByUserId | 1.0 |
1.9 | 根据人员删除人脸梯控授权 | /v1/iot/lift/liftAuthorizeControl/faceLiftDeleteByUserId | 1.0 |
1.10 | 根据新增人员房产信息授权梯控 | /v1/iot/lift/liftAuthorizeControl/refreshUserLiftAuthorize | 1.0 |
API调用
1.1: 梯控授权分页查询
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/lift/liftAuthorizeControl/liftAuthorizeList
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
projectId | body | string | y | 项目Id |
userId | body | string | y | 用户Id ,拜访的那个住户或者员工id |
userType | body | list | y | 如示例,传入 VISITOR "userType":["VISITOR"] |
请求Body描述(非Form表单数据)
{
"projectId": "123333",
"type": "OWNER",
"userId": "23345",
"userType":["VISITOR"]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
success | 顶层 | boolean | 是 | 是否成功 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
list | data | JSONArray | 是 | 数据列表 |
liftAuthorizeId | data.list | string | 是 | 授权Id |
deviceName | data.list | string | 是 | 设备名 |
deviceId | data.list | string | 是 | 设备Id |
deviceSn | data.list | string | 是 | 设备sn |
mac | data.list | string | 是 | mac |
status | data.list | int | 是 | 在离线状态 |
areaId | list | string | y | 项目id |
areaName | list | string | y | 项目名 |
buildId | list | string | y | 建筑id |
buildName | list | string | y | 建筑名 |
unitNames | list | JSONArray | y | 单元名 |
unitIds | list | JSONArray | y | 单元Id |
callType | list | JSONArray | y | 单元Id |
numList | list | JSONArray | y | 楼层列表 |
publicFloors | list | JSONArray | y | 公共楼层 |
nonPublicFloors | list | JSONArray | y | 非公共楼层 |
endTime | list | string | y | 授权结束时间 |
startTime | list | string | y | 授权开始时间 |
authorizeType | list | int | y | 授权方式 0 自动 1手动 |
authorizePerson | list | string | y | 授权人 |
instanceId | list | string | y | 实例标识 |
allowedOpeningTimes | list | int | y | 剩余呼梯次数 |
authValidFlag | list | int | y | 授权时间有效标示 0 有效 1 授权过期 2 授权时间未到 |
userId | list | string | y | 用户标识 |
isOnline | list | bool | y | 设备在线状态 |
prohibit | list | bool | y | 梯控是否被禁用 |
isEnable | list | int | y | 0-禁用;1-启用 |
authorizationUserIds | list | JSONArray | y | 授权用户标识 |
bizFaceAuthFlag | list | int | y | 人脸授权标识 |
nums | list | JSONArray | y | 楼层列表 |
projectId | list | string | y | 项目Id |
productId | list | string | y | 产品Id |
instanceName | list | string | y | 实例名称 |
返回结果示例
{
"responseTime": "2020-10-27T07:04:37.662+0000",
"code": "000000",
"status": "200",
"msg": "请求成功",
"data": {
"list": [{
"liftAuthorizeId": "4b5f87f77bbe5aeb75e8458ff4",
"deviceName": "大华梯控02",
"deviceId": "1416375300",
"deviceSn": "",
"mac": "21441118_1000002_7_0_0_ECS",
"status": 0,
"areaAame": null,
"areaId": null,
"buildName": "1栋",
"buildId": "50410653",
"unitNames": ["1单元"],
"unitIds": ["50410663"],
"callType": ["LONG_RANGE", "FACE"],
"numList": ["-3F", "-2F", "-1F"],
"publicFloors": ["-3F", "-2F"],
"nonPublicFloors": ["-1F"],
"endTime": 1604159999000,
"startTime": 1603382400000,
"authorizeType": 1,
"authorizePerson": "陆健华",
"instanceId": "475f87f64ebe5aeb75e8458fda",
"allowedOpeningTimes": null,
"authValidFlag": 0,
"userId": "46868474",
"isOnline": false,
"prohibit": false,
"isEnable": 1,
"authorizationUserIds": ["905f894da0dd622b666b5d6aff", "935f894e83dd622b666b5d6b00"],
"bizFaceAuthFlag": 2,
"nums": [-3, -2, -1],
"projectId": "21441118",
"productId": "160004bb72c0232a160004bb72c0b201",
"instanceName": "实验室梯控"
}],
"count": 1,
"current_page": 0,
"per_page": null
}
}
1.2: 新增梯控授权
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/lift/liftAuthorizeControl/addLiftAuthorize
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
userId | body | string | y | 业主标识 |
userName | body | string | y | 业主名 |
userPhone | body | string | y | 业主电话 |
staffAccount | body | string | y | 员工账号 |
userType | body | string | y | 用户类型 |
instanceId | body | string | y | 实例标识 |
authorizePerson | body | string | y | 授权人 |
authorizeType | body | int | y | 授权方式 0 自动 1手动 |
endTime | body | Timestamp | y | 结束时间 |
startTime | body | Timestamp | y | 开始时间 |
floorNums | body | JSONArray | y | 授权楼层号列表 |
projectId | body | string | y | 项目标识 |
请求Body描述(非Form表单数据)
{
"userId": "46868888",
"userName" : "测试名",
"userPhone": "13666666666",
"staffAccount": "test001",
"userType": "STAFF",
"instanceId": "305eb4c38abe5aeb4d1da86ff0",
"authorizePerson": "hh哈",
"authorizeType": 1,
"projectId": "21441118",
"startTime": 1603728000000,
"endTime": 1604159999000,
"floorNums": [-2, -1, 1, 4, 5]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
success | 顶层 | boolean | y | 是否成功 |
data | 顶层 | boolean | y | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": true
}
1.3: 修改梯控授权
描述
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/lift/liftAuthorizeControl/updateLiftAuthorize
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
liftAuthorizeId | body | string | y | 授权标识 |
endTime | body | Timestamp | y | 结束时间 |
startTime | body | Timestamp | y | 开始时间 |
floorNums | body | JSONARRAY | y | 修改楼层授权 |
instanceId | body | string | y | 实例标识 |
请求Body描述(非Form表单数据)
{
"liftAuthorizeId": "5c5f8a5b19be5aeb0b6fca9bd2",
"endTime": 1604159999000,
"startTime": 1603728000000,
"floorNums": [-2, -1, 1, 4, 5, 6],
"instanceId": "305eb4c38abe5aeb4d1da86ff0"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | boolean | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": true
}
1.4: 批量移除梯控授权
描述
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/lift/liftAuthorizeControl/deleteLiftAuthorize
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
liftAuthorizeIds | body | JSONArray | y | 待删除的授权Id |
请求Body描述(非Form表单数据)
{
"liftAuthorizeIds": ["5b5f97fdf7be5aeb57abca3d11"]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | boolean | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
}
}
1.5: 根据梯控实例查询梯控授权用户
描述
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/lift/liftAuthorizeControl/liftAuthorizeDeviceList
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
projectId | body | string | y | 项目Id |
instanceId | body | string | y | 实例Id |
userType | body | JSONArray | y | 用户类型 |
userName | body | string | y | 用户名 |
userPhone | body | string | y | 用户电话 |
staffAccount | body | string | y | 员工账号 |
请求Body描述(非Form表单数据)
{
"projectId":"21441118",
"instanceId":"21441118",
"userType":["OWNER"],
"userName":"测试名",
"userPhone":"1366666666",
"staffAccount":"test001"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
userIds | data | JSONArray | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"customers":[{
"houses":[{
"name":""12栋_1单元_2501",
"custType":"C1001" //C1000业主 C1001业主成员 C2000租户 C2001租户成员
}]
"custName":"测试住户名",
"custPhone":"13666666666",
}]
}
}
1.6: 梯控人脸授权
描述
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/lift/liftAuthorizeControl/liftFaceAuthorize
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
list | body | JSONArray | y | 人脸授权列表 |
projectId | body | string | y | 项目Id |
liftAuthorizeId | body | string | y | 授权id |
authorizePerson | body | string | y | 授权人 |
imageUrl | body | string | y | 头像图片 |
请求Body描述(非Form表单数据)
{
"list":{
"projectId":"21441118",
"liftAuthorizeId":"1604568131994882",
"authorizePerson":"测试授权人",
"imageUrl":"www.baiduc.com"
}
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
result | data | JSONArray | 是 | 响应数据对象 |
liftAuthorizeId | result | string | 是 | 梯控授权Id |
success | result | boolean | 是 | 梯控授权结果 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"result":[{
"liftAuthorizeId":"1604568131994882",
"success" :"true"
}
]
}
}
1.7: 禁用梯控
描述
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/lift/liftAuthorizeControl/switchLiftAuthorize
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
liftAuthorizeId | body | string | y | 授权id |
prohibit | body | boolean | y | 是否禁用 |
imageUrl | body | string | y | 头像图片 |
请求Body描述(非Form表单数据)
{
"liftAuthorizeId":"1604568131994882",
"prohibit":true,
"imageUrl":"www.baidu.com",
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
result | data | JSONArray | 是 | 响应数据对象 |
liftAuthorizeId | result | string | 是 | 梯控授权Id |
success | result | boolean | 是 | 梯控授权结果 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"liftAuthorizeId":"1604568131994882",
"success" :"true"
}
}
1.8: 根据人员授权人脸梯控
描述
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/lift/liftAuthorizeControl/faceLiftAuthorizeByUserId
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
projectId | body | string | y | 项目Id |
userId | body | string | y | 用户id |
imageUrl | body | string | y | 头像图片 |
请求Body描述(非Form表单数据)
{
"projectId":"21441118",
"userId":"12333",
"imageUrl":"www.baiduc.com"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
result | data | JSONArray | 是 | 响应数据对象 |
liftAuthorizeId | result | string | 是 | 梯控授权Id |
success | result | boolean | 是 | 梯控授权结果 |
message | result | string | 是 | 梯控成功或失败原因 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"result":[{
"liftAuthorizeId":"1604568131994882",
"success" :"true",
"message":"下发成功"
}
]
}
}
1.9: 根据人员删除人脸梯控授权
描述
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/lift/liftAuthorizeControl/faceLiftDeleteByUserId
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
projectId | body | string | y | 项目Id |
userId | body | string | y | 用户id |
请求Body描述(非Form表单数据)
{
"projectId":"21441118",
"userId":"12333"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
result | data | JSONArray | 是 | 响应数据对象 |
liftAuthorizeId | result | string | 是 | 梯控授权Id |
success | result | boolean | 是 | 梯控授权结果 |
message | result | string | 是 | 梯控成功或失败原因 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"result":[{
"liftAuthorizeId":"1604568131994882",
"success" :"true",
"message":"下发成功"
}
]
}
}
1.10: 根据新增人员房产信息授权梯控
描述 查询主数据该人的房产,根据房产信息授权梯控
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/lift/liftAuthorizeControl/refreshUserLiftAuthorize
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
projectId | body | string | y | 项目Id |
userId | body | string | y | 用户id |
请求Body描述(非Form表单数据)
{
"projectId":"21441118",
"userId":"12333"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
}
}