1. 门禁住户及授权

API列表

编号	API名称	路径	版本
1.1	住户新增	/v1/iot/door/resident/doorResident/insertResident	1.0
1.2	住户列表查询	/v1/iot/door/resident/doorResident/queryResidents	1.0
1.3	住户查询	/v1/iot/door/resident/doorResident/queryResidentInfo/{id}	1.0
1.4	更新人面	/v1/iot/door/resident/doorResident/updateUserFace	1.0
1.5	查询人面	/v1/iot/door/resident/doorResident/queryUserFace	1.0
1.6	新增授权	/v1/iot/door/resident/doorAuthorization/insertDoorAuthorization	1.0
1.7	更改授权	/v1/iot/door/resident/doorAuthorization/updateDoorAuthorization	1.0
1.8	删除授权	/v1/iot/door/resident/doorAuthorization/deleteDoorAuthorization	1.0
1.9	查询授权	/v1/iot/door/resident/doorAuthorization/queryDoorAuthorizations	1.0
2.0	授权人脸	/v1/iot/door/resident/doorAuthorization/sendFaceToDevice	1.0
2.1	查询授权(类型)	/v1/iot/door/resident/doorAuthorization/queryDoorAuthorizationsByType	1.0
2.2	住户人员信息查询	/v1/iot/door/resident/doorAuthorization/queryDoorCustomerList	1.0
2.3	授权详情信息	/v1/iot/door/resident/doorAuthorization/queryDoorAuthorizationsInfo	1.0
2.4	查询人面	/v1/iot/door/face/doorFaceRecognition/queryFaceRecognitionInfoByPerson	1.0
2.5	人面授权	/v1/iot/door/face/doorFaceRecognition/sendFaceToDeviceByPerson	1.0
2.6	人面下发设备	/v1/iot/door/resident/doorAuthorization/sendFaceToDevice	1.0
2.7	员工人员信息查询	/v1/iot/door/resident/doorAuthorization/queryDoorEmployeList	1.0
2.8	员工授权详情信息	/v1/iot/door/resident/doorAuthorization/queryDoorAuthorizationsInfo	1.0
2.9	人面授权(单个权限下发)	/v1/iot/door/face/doorFaceRecognition/sendFaceToDeviceByAuth	1.0
3.0	授权启用禁用	/v1/iot/door/resident/doorAuthorization/enableAuthorization	1.0
3.1	人面授权(根据设备下发)	/v1/iot/door/face/doorFaceRecognition/sendFaceToDeviceByDevice	1.0
3.2	人面授权(删除人脸)	/v1/iot/door/face/doorFaceRecognition/deleteFaceToDeviceByPerson	1.0
3.3	根据客户ID自动授权	/v1/iot/door/resident/doorAuthorization/autoAuthorizeByPersonId	1.0

API调用

1.1: 住户新增

描述住户新增

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/resident/doorResident/insertResident

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
userName	body	string	y	登录人
projectId	body	string	y	项目id
residentName	body	string	y	住户名
identity	body	string	y	证书名
gender	body	string	y	性别
phone	body	string	y	电话
residentType	body	string	y	住户类型
houseId	body	string	y	住户房屋
isCust	body	string	y	是否公司客户
contactPerson	body	string	n	联系人
contactPhone	body	string	n	联系电话
organizationCode	body	string	n	组织编码

请求Body描述(非Form表单数据)

{
    "userName": "潘生",
    "projectId":"21441121",
    "residentName":"潘生",
    "identity":"11111111",
    "gender":"男",
    "phone":"13800138000",
    "residentType": "1",
    "isCust":"0",
    "contactPerson": "潘生",
    "contactPhone":"133800138000",
    "organizationCode":"1",
    "houseId":"132558"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
success	顶层	boolean	是	是否成功
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "result": true
    }
}

1.2: 住户列表查询

描述住户列表查询

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/resident/doorResident/queryResidents

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
pageNo	body	int	y	页码
pageSize	body	int	y	页数
buildingId	body	string	n	楼栋id
unitId	body	string	n	单元id
houseId	body	string	n	房屋id
personName	body	string	n	人员
phone	body	string	n	电话

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "buildingId": null,
    "unitId": null,
    "houseId": "132558",
    "personName": "潘生",
    "phone": "13800138000"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	y	响应码标识
success	顶层	boolean	y	是否成功
data	顶层	boolean	y	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": [
        {
            "id": "728",
            "name": "潘生",
            "phone": "13800138000",
            "certificateType": "业主",
            "certificateId": "11111111",
            "houseName": "一座_1单元_203"
        },
        {
            "id": "729",
            "name": "潘生",
            "phone": "13800138000",
            "certificateType": "业主",
            "certificateId": "11111111",
            "houseName": "一座_1单元_203"
        }
    ]
}

1.3: 住户查询

描述住户查询

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorResident/queryResidentInfo/{id}

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "name": "潘生",
        "phone": "13800138000",
        "certificateId": "11111111",
        "houseName": "一座_1单元_203"
    }
}

1.4: 更新人面

描述更新人面

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorResident/updateUserFace

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
residentId	body	string	y	住户id
projectId	body	string	y	项目id
faceUrl	body	string	y	人脸url

请求Body描述(非Form表单数据)

{
    "residentId": 728,
    "projectId": 21441121,
    "faceUrl": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/8c6adde2c56bda49a634b6990c817f23"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "result": true
    }
}

1.5: 查询人面

描述查询人面

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorResident/queryUserFace

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
residentId	body	string	y	住户id
projectId	body	string	y	项目id

请求Body描述(非Form表单数据)

{
    "residentId": 728,
    "projectId": 21441121
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "id": 1,
        "residentId": 728,
        "faceUrl": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/8c6adde2c56bda49a634b6990c817f23",
        "projectId": 21441121
    }
}

1.6: 新增授权

描述新增授权

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/insertDoorAuthorization

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
projectId	body	string	y	项目id
effectiveTime	body	string	n	有效时间
expiredTime	body	string	n	失效时间
authorizerName	body	string	n	授权人
type	body	int	y	类型 1 住户 2 员工
devices	body	JSONARRY	y	设备信息
deviceId	devices	string	y	设备id
persons	body	JSONARRY	y	住户信息
personId	persons	string	y	住户id
personType	persons	string	y	住户类型
personName	persons	string	y	住户姓名
phone	persons	string	y	电话号码

请求Body描述(非Form表单数据)

{
   "projectId": 21441121,
   "effectiveTime": null,
   "expiredTime": null,
   "authorizerName":"潘生",
   "type": 1,
   "devices": [
       {
           "deviceId": "619a22e35078421f"
       }
   ],
   "persons": [
       {
           "personId": "728",
           "personType": 1,
           "personName":"1",
           "phone": "1"
       }
   ]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "result": true
    }
}

1.7: 更改授权

描述更改授权

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/updateDoorAuthorization

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
id	body	string	y	授权id
effectiveTime	body	string	n	有效时间
expiredTime	body	string	n	失效时间

请求Body描述(非Form表单数据)

{
   "id":2,
   "effectiveTime":"2020-09-19 12:00:00",
   "expiredTime": "2020-09-20 12:00:00"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "result": true
    }
}

1.8: 删除授权

描述删除授权

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/deleteDoorAuthorization

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
id	body	string	y	授权id

请求Body描述(非Form表单数据)

[
    2 
]

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "result": true
    }
}

1.9: 查询授权信息

描述查询授权信息

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/queryDoorAuthorizations

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
pageNo	body	int	y	页码
pageSize	body	int	y	页数
personId	body	int	y	住户id
buildingId	body	int	n	楼栋id
unitId	body	int	n	单元id
houseId	body	int	n	房屋id
parkingId	body	int	n	停车场id
publicAreaId	body	int	n	公共场所id
deviceName	body	int	n	设备编码

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "personId": "728",
    "buildingId": "50411629",
    "unitId": null,
    "houseId": null,
    "parkingId": null,
    "publicAreaId": null,
    "deviceName": "实验室门禁"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": [
        {
            "id": 3,
            "projectId": 21441121,
            "productId": 160,
            "personId": "728",
            "personName": "潘生",
            "deviceId": "619a22e35078421f",
            "deviceName": "实验室门禁",
            "authorizedMode": "人工授权",
            "doorTypename": "业主",
            "authScope": "一栋测试房",
            "openMode": "人脸",
            "effective": "无限期",
            "createName": "潘生",
            "type": "1住户2员工"
        }
    ]
}

2.0: 授权人脸

描述授权人脸

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/sendFaceToDevice

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
projectId	body	string	y	项目id
doorLockId	body	string	y	门禁id
productId	body	string	y	产品id
mac	body	string	y	mac
ip	body	string	n	ip
port	body	string	n	port
userName	body	string	n	userName
password	body	string	n	password
sn	body	string	n	sn
authorizationUserId	body	string	n	授权人id
method	body	string	n	方法
opType	body	string	n	0删除，1新增
personInfos	body	JSONARRY	n	授权人员信息
personId	personInfos	string	y	人员id
mac	personInfos	string	n	mac
personType	personInfos	string	n	人员类型
personName	personInfos	string	y	人员名称
faceId	personInfos	string	n	人脸
imageUrl	personInfos	string	y	人脸图像url

请求Body描述(非Form表单数据)

[{
    "projectId":"21291194",
    "doorLockId": 26,
    "productId": "160",
    "mac":"21291194_1000002_7_0_0",
    "ip": null,
    "port": null,
    "userName": null,
    "password": null,
    "sn": "BBBB",
    "authorizationUserId":"1",
    "method":"face_recognition_batch_control",
    "opType":"1/0",
    "personInfos": [
        {
            "personId":"728",
            "mac":"21291194_1000002_7_0_0",
            "personType": 1,
            "personName":"潘生",
            "faceId": 1,
            "imageUrl":"hangzhou.aliyuncs.com/8c6adde2c56bda49a634b6990c817f23"
        }
    ]
}]

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {}
}

2.1: 查询授权信息(类型)

描述查询授权信息(类型)

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/queryDoorAuthorizationsByType

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
deviceId	body	string	y	设备id
type	body	string	y	类型
personName	body	string	n	住户名/员工名
pageNo	body	int	y	页码
pageSize	body	int	y	页数

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "type": 1,
    "deviceId": "13ee21bcbbf97630",
    "personName": "1"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "total": 525,
        "list": [
            {
                "id": "229",
                "type": "1",
                "personName": "黄艳月",
                "phone": "",
                "doorTypename": "业主",
                "authScope": "B区17栋",
                "account": "",
                "mail": ""
            }
        ]
    }
}

2.2: 住户人员信息查询

描述住户人员信息查询

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/queryDoorCustomerList

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
projectId	body	string	y	项目id
personOrPhone	body	string	n	姓名/电话
houseId	body	string	n	房屋id
custType	body	string	n	身份类型

请求Body描述(非Form表单数据)

{
    "projectId":"610",
    "personOrPhone":"15818",
    "custType": "1000，1001"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "total": "9",
        "list": [
            {
                "total": "9",
                "projectId": "610",
                "personId": "410001",
                "personName": "吴美蓉",
                "phone": "15818003888",
                "houseName": "12栋_1单元_25011栋_1单元_1013区商铺_1单元_193区商铺_1单元_20",
                "personType": ""
            }
        ]
    }
}

2.3: 授权详细信息接口

描述授权详细信息接口

请求信息

HTTP协议：HTTP,HTTPS

uri： v1/iot/door/resident/doorAuthorization/queryDoorAuthorizationsInfo

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
pageNo	body	int	y	页码
pageSize	body	int	y	页数
personId	body	string	y	住户id
projectId	body	string	y	项目id
type	body	string	y	1 住户 2 员工

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "personId": "410001",
    "projectId": "610",
    "type": "1" //住户
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "custInfo": {
            "personName": "吴美蓉",
            "houseName": "12栋_1单元_2501,1栋_1单元_101,3区商铺_1单元_19,3区商铺_1单元_20",
            "faceUrl": "",
            "phone": "15818003888",
            "personId": "410001",
            "personType": "业主成员",
            "projectId": "610"
        },
        "authorizationCust": [
            {
                "id": 3,
                "projectId": 610,
                "productId": 160,
                "personId": "410001",
                "personName": "潘生",
                "deviceId": "619a22e35078421f",
                "deviceName": "实验室门禁",
                "authorizedMode": "人工授权",
                "doorTypename": "业主",
                "authScope": "一栋测试房",
                "openMode": "人脸",
                "effective": "无限期",
                "createName": "潘生",
                "sendFace": "下发人脸数",
                "deleteFace": "删除人脸数"
            }
        ]
    }
}

2.4: 根据人员id获取人脸信息

描述根据人员id获取人脸信息

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorFaceRecognition/queryFaceRecognitionInfoByPerson

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
personId	body	string	y	住户id

请求Body描述(非Form表单数据)

{
   "personId": "728"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "custInfo": {
            "personName": "吴美蓉",
            "houseName": "12栋_1单元_2501,1栋_1单元_101,3区商铺_1单元_19,3区商铺_1单元_20",
            "faceUrl": "",
            "phone": "15818003888",
            "personId": "410001",
            "personType": "业主成员",
            "projectId": "610"
        },
        "authorizationCust": [
            {
                "id": 3,
                "projectId": 610,
                "productId": 160,
                "personId": "410001",
                "personName": "潘生",
                "deviceId": "619a22e35078421f",
                "deviceName": "实验室门禁",
                "authorizedMode": "人工授权",
                "doorTypename": "业主",
                "authScope": "一栋测试房",
                "openMode": "人脸",
                "effective": "无限期",
                "createName": "潘生"
            }
        ]
    }
}

2.5: 人脸授权

描述人脸授权

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorFaceRecognition/sendFaceToDeviceByPerson

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
personId	body	string	y	住户id
projectId	body	string	y	项目id

请求Body描述(非Form表单数据)

{
   "personId": "410001",
   "projectId": "610"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": []
}

2.5: 人脸下发设备

描述人脸下发设备

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/sendFaceToDevice

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
params	body	list	y	下发人脸信息
projectId	params	string	y	项目id
doorLockId	params	string	y	门禁接入id
productId	params	string	y	产品id
mac	params	string	y	mac
authorizationId	params	string	y	项目id
method	params	string	y	方法
opType	params	string	y	操作类型
personInfos	params	jsonobject	y	人员信息
personId	personInfos	string	y	人员id
personType	personInfos	string	y	人员类型
personName	personInfos	string	y	人员名
imageUrl	personInfos	string	y	人脸url

请求Body描述(非Form表单数据)

{
    "params": [
        {
            "projectId": "50450049",
            "doorLockId": "46",
            "productId": "160",
            "mac":"50450049_1000012_7_0_0",
            "authorizationId":"3",
            "method":"face_recognition_batch_control",
            "opType": "1",
            "personInfos": {
                "personId": "410001",
                "personType": "1000",
                "personName": "潘生",
                "imageUrl": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/3.jpg"
            }
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": []
}

2.7: 员工信息查询

描述员工信息查询

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/queryDoorEmployeList

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
pageNo	body	int	y	页码
pageSize	body	int	y	页数
bizOrgCode	body	int	y	业务组织码
projectId	body	int	y	项目id
name	body	string	n	姓名
phone	body	string	n	电话

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "bizOrgCode": "600004bb5595c600",
    "projectId": "33333"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "total": 129,
        "list": [
            {
                "personId": "120004ba87eb9600",
                "empName": "陈慧丽test",
                "empPhone": "13800138012",
                "empAccount": "",
                "empOrgName": "1015业务组织/1015组织片区/领贤体验馆02"
            }
        ]
    }
}

2.8: 员工授权详细信息

描述员工授权详细信息

请求信息

HTTP协议：HTTP,HTTPS

uri： v1/iot/door/resident/doorAuthorization/queryDoorAuthorizationsInfo

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
pageNo	body	int	y	页码
pageSize	body	int	y	页数
personId	body	string	y	住户id
projectId	body	string	y	项目id
type	body	string	y	1 住户 2 员工
bizOrgCode	body	string	y	业务组织编码
account	body	string	y	员工账号

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "type": "2", //员工
    "projectId":"1111",
    "personId": "1200a8bf30c04e00",
    "bizOrgCode": "600004bb5595c600",
    "account": "wangxf113"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "custInfo": {
            "personName": "吴美蓉",
            "houseName": "12栋_1单元_2501,1栋_1单元_101,3区商铺_1单元_19,3区商铺_1单元_20",
            "faceUrl": "",
            "phone": "15818003888",
            "personId": "410001",
            "personType": "业主成员",
            "projectId": "610"
        },
        "authorizationCust": [
            {
                "id": 3,
                "projectId": 610,
                "productId": 160,
                "personId": "410001",
                "personName": "潘生",
                "deviceId": "619a22e35078421f",
                "deviceName": "实验室门禁",
                "authorizedMode": "人工授权",
                "doorTypename": "业主",
                "authScope": "一栋测试房",
                "openMode": "人脸",
                "effective": "无限期",
                "createName": "潘生"
            }
        ]
    }
}

2.9: 人脸授权(单个权限)

描述人脸授权

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorFaceRecognition/sendFaceToDeviceByAuth

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
personId	body	string	y	住户id
projectId	body	string	y	项目id
authId	body	string	y	单个授权id

请求Body描述(非Form表单数据)

{
   "personId": "410001",
   "projectId": "610",
   "authId": "1"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": []
}

3.0: 授权启用禁用

描述授权启用禁用

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/enableAuthorization

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
authorizationId	body	string	y	授权id
enable	body	string	y	是否启用

请求Body描述(非Form表单数据)

{
   "authorizationId": "1",
   "enable": "1/0"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": true
}

3.1: 人脸授权(根据设备下发)

描述人脸授权

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorFaceRecognition/sendFaceToDeviceByDevice

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
deviceId	body	string	y	设备id
projectId	body	string	y	项目id

请求Body描述(非Form表单数据)

{
   "deviceId": "1",
   "projectId": "610"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": []
}

3.2: 人脸授权(删除人脸)

描述人脸授权

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorFaceRecognition/deleteFaceToDeviceByPerson

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
personId	body	string	y	住户id
projectId	body	string	y	项目id

请求Body描述(非Form表单数据)

{
   "deviceId": "1",
   "projectId": "610"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": []
}

3.3: 根据客户ID自动授权

描述根据客户ID自动授权

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/resident/doorAuthorization/autoAuthorizeByPersonId 方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
communityId	body	string	y	社区id
customerId	body	string	y	客户id

请求Body描述(非Form表单数据)

{
    "communityId": "92",
    "customerId": "402"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "200",
    "success": true,
    "data": []
}

1. 门禁住户及授权

API列表

API调用

1.1: 住户新增

描述 住户新增

请求信息

header

请求参数

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

1.2: 住户列表查询

描述 住户列表查询

请求信息

header

请求参数

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

1.3: 住户查询

描述 住户查询

请求信息

header

请求参数

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

1.4: 更新人面

描述 更新人面

请求信息

header

请求参数

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

1.5: 查询人面

描述 查询人面

请求信息

header

请求参数

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

1.6: 新增授权

描述 新增授权

请求信息

header

请求参数

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

1.7: 更改授权

描述 更改授权

请求信息

header

请求参数

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

1.8: 删除授权

描述 删除授权

请求信息

header

请求参数

请求Body描述(非Form表单数据)

返回信息

描述住户新增

描述住户列表查询

描述住户查询

描述更新人面

描述查询人面

描述新增授权

描述更改授权

描述删除授权

描述查询授权信息

描述授权人脸

描述查询授权信息(类型)

描述住户人员信息查询

描述授权详细信息接口

描述根据人员id获取人脸信息

描述人脸授权