门禁人员查询接口文档
一、接口名称
查询门禁人员信息
二、接口描述
用于外部系统查询小区门禁人员信息的接口，支持分页查询
三、接口路径
http://{ip}:{port}/iot/api/accessControlFace.listAccessControlFace
四、请求方法
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 查询参数
| 参数名称 | 必填 | 类型 | 格式 | 描述 | 示例 |
|---|---|---|---|---|---|
| communityId | 是 | String | - | 小区ID | 123123 |
| page | 否 | Integer | - | 页码，默认1 | 1 |
| row | 否 | Integer | - | 每页行数，默认10 | 10 |
七、返回值
7.1 响应格式
JSON
7.2 响应状态码
200 - 请求成功
400 - 参数验证失败
500 - 服务器内部错误
7.3 响应体结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 返回码，0表示成功 |
| msg | String | 返回信息 |
| data | Object | 返回数据 |
data对象结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| totalPage | Integer | 总页数 |
| records | Integer | 总记录数 |
| accessControlFaces | Array | 门禁人员列表 |
accessControlFaces数组元素结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| machineId | String | 设备编号 |
| userId | String | 人员ID |
八、示例请求
GET http://127.0.0.1:8080/iot/api/accessControlFace.listAccessControlFace?communityId=123123&page=1&row=10
请求头示例：
Authorization: Bearer xxxxxxx
app-id: iot-access-control
transaction-id: 100000000020230101120000000001
sign: xxxxxxxxxxxxxxxx
req-time: 20230101120000
九、示例响应
{
"code": 0,
"msg": "成功",
"data": {
"totalPage": 5,
"records": 50,
"accessControlFaces": [
{
"machineId": "123123",
"userId": "123213"
},
{
"machineId": "123124",
"userId": "123214"
}
]
}
}
十、业务逻辑说明
- 接口会验证必填参数communityId是否存在
- 验证分页参数page和row的合法性
- 调用IAccessControlFaceV1InnerServiceSMO服务查询门禁人员信息
- 返回分页后的门禁人员列表数据
十一、注意事项
- communityId为必填参数，否则会返回参数验证失败
- 分页参数page和row有默认值，可以不传
- 接口需要认证token才能访问