查询人员信息接口文档

一、接口名称

查询人员信息

二、接口描述

该接口用于第三方系统（如招商系统）查询小区内的人员信息，支持分页查询和多种条件筛选，可查询业主及家庭成员信息。

三、接口路径

http://{ip}:{port}/iot/api/owner.queryOwners

四、请求方法

GET

五、请求头

参数名称	必填	类型	描述
Authorization	是	String	用户认证token Base token 通过登录接口获取token
app-id	是	String	应用ID 系统dev账户分配
transaction-id	是	String	请求流水号不能重复 1000000000+YYYYMMDDhhmmss+6位序列
sign	是	String	签名
req-time	是	String	请求时间 YYYYMMDDhhmmss

六、请求参数

6.1 查询参数

参数名称	必填	类型	长度	描述	示例
page	是	int	11	页数	1
row	是	int	11	每页行数	10
communityId	是	String	30	小区ID	2022121921870161
name	否	String	64	人员名称	张三
link	否	String	11	人员手机号	18909718888
idCard	否	String	30	人员身份证号	110101199003077777
ownerTypeCd	否	String	12	人员类型：1001-人员，2002-家庭成员（查询家庭成员时需要传ownerId）	1001
ownerId	否	String	30	人员ID（查询家庭成员时需要）	772023012589770046
memberId	否	String	30	人员主键ID	772023012589770046
roomName	否	String	-	房屋名称（格式：楼栋-单元-房屋）	1-1-101

七、返回值

7.1 响应格式

JSON

7.2 响应状态码

200 - 请求成功
400 - 参数错误
500 - 服务器内部错误

7.3 响应参数

参数名称	类型	描述
code	int	返回码：0-成功，其他-失败
msg	String	返回信息
owners	Array	人员信息列表
page	int	当前页数
records	int	当前页记录数
rows	int	每页行数
total	int	总记录数

owners数组字段说明：

参数名称	类型	长度	描述
communityId	String	30	小区ID
name	String	64	人员名称
link	String	11	人员手机号
idCard	String	30	人员身份证号
address	String	512	地址
sex	String	12	性别：1-男，0-女
ownerTypeCd	String	12	人员类型：1001-人员，2002-家庭成员
remark	String	512	备注
memberId	String	30	人员ID
ownerPhoto	String	-	人员人脸照片URL（用于同步门禁人脸开门）
roomCount	String	-	房屋数量
carCount	String	-	车辆数量
urls	Array	-	照片URL列表

八、示例请求

GET http://127.0.0.1:8008/iot/api/owner.queryOwners?ownerTypeCd=1001&page=1&row=10&communityId=2022121921870161

九、示例响应

{
    "owners": [
        {
            "address": "张三",
            "idCard": "",
            "link": "18909718888",
            "memberId": "772023012589770046",
            "name": "王王",
            "ownerId": "772023012589770046",
            "ownerTypeCd": "1001",
            "remark": "",
            "sex": "0",
            "userName": "人和物业",
            "roomCount": "2",
            "carCount": "1",
            "urls": [
                "http://example.com/upload/face/772023012589770046.jpg"
            ]
        }
    ],
    "page": 0,
    "records": 1,
    "rows": 0,
    "total": 1
}

十、业务逻辑说明

接口首先验证必填参数（page、row、communityId）和参数格式
如果传入了roomName参数，会先查询房屋信息获取roomId
查询人员总数和分页数据
对于每个人员，查询其关联的房屋数量、车辆数量和照片信息
返回分页结果和人员详细信息

十一、注意事项

查询家庭成员（ownerTypeCd=2002）时必须传入ownerId参数
roomName参数格式必须为"楼栋-单元-房屋"（如"1-1-101"）
照片URL会根据配置自动拼接完整路径

基础接口

门禁

道闸

查询人员信息接口文档

一、接口名称

二、接口描述

三、接口路径

四、请求方法

五、请求头

六、请求参数

6.1 查询参数

七、返回值

7.1 响应格式

7.2 响应状态码

7.3 响应参数

owners数组字段说明：

八、示例请求

九、示例响应

十、业务逻辑说明

十一、注意事项