HC小区接口文档

基础接口

登陆 添加人员 修改人员 查询人员 删除人员

门禁

添加门禁 修改门禁 查询门禁 门禁开门 重启门禁 门禁授权 删除授权 查询授权 开门记录 删除门禁

道闸

查询停车场 删除车位 查询车位 添加车位 修改车位 添加车辆 修改车辆 删除车辆 查询车辆 查询道闸 开闸 关闸

门禁出入记录查询接口文档

一、接口名称

查询门禁出入记录列表

二、接口描述

该接口用于查询小区门禁的出入记录，支持分页查询，可根据房屋ID筛选特定房屋的出入记录。

三、接口路径

http://ip:port/iot/api/accessControlInout.ListAccessControlInout

四、请求方法

GET

五、请求头

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

六、请求参数

6.1 查询参数

参数名称 必填 类型 描述
communityId 是 String 小区ID
roomId 否 String 房屋ID（可选，用于筛选特定房屋的出入记录）
page 否 Integer 当前页码（默认1）
row 否 Integer 每页记录数（默认10）

七、返回值

7.1 返回值结构

参数名称 类型 描述
code String 返回码，0 表示成功，其他表示失败
msg String 返回信息
data Object 返回数据

7.2 data 结构

参数名称 类型 描述
total Integer 总记录数
records Integer 当前页记录数
rows List<AccessControlInoutDto> 门禁出入记录列表

7.3 AccessControlInoutDto 结构

参数名称 类型 描述
inoutId String 出入记录ID
communityId String 小区ID
roomId String 房屋ID
personName String 人员姓名
tel String 联系电话
inoutType String 出入类型（0-进入，1-离开）
inoutTime String 出入时间（格式：YYYY-MM-DD HH:mm:ss）
deviceId String 门禁设备ID
deviceName String 门禁设备名称

八、示例请求

请求URL 

http://127.0.0.1:8080/iot/api/accessControlInout.ListAccessControlInout?communityId=123456&page=1&row=10

请求头示例 

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
app-id: 10001
transaction-id: 100000000020231015143456123456
sign: 9a8b7c6d5e4f3g2h1i0j
req-time: 20231015143456

九、示例响应

成功响应 

{
  "code": "0",
  "msg": "成功",
  "data": {
    "total": 15,
    "records": 10,
    "rows": [
      {
        "inoutId": "1001",
        "communityId": "123456",
        "roomId": "101",
        "personName": "张三",
        "tel": "13800138000",
        "inoutType": "0",
        "inoutTime": "2023-10-15 10:30:45",
        "deviceId": "D001",
        "deviceName": "小区南门"
      },
      {
        "inoutId": "1002",
        "communityId": "123456",
        "roomId": "102",
        "personName": "李四",
        "tel": "13900139000",
        "inoutType": "1",
        "inoutTime": "2023-10-15 11:15:20",
        "deviceId": "D002",
        "deviceName": "小区北门"
      }
    ]
  }
}

失败响应 

{
  "code": "1001",
  "msg": "小区ID不能为空",
  "data": null
}

十、业务逻辑说明

  1. 参数校验：

    • 必须传入 communityId（小区ID）。
    • 如果传入 roomId（房屋ID），则进一步查询该房屋关联的人员信息，并筛选对应的门禁记录。

  2. 分页查询：

    • 默认每页10条记录，可通过 page 和 row 调整分页参数。

  3. 数据返回：

    • 返回分页后的门禁出入记录列表，包含总记录数和当前页数据。

十一、数据库操作

  1. 查询 access_control_inout 表获取出入记录。
  2. 如果传入 roomId，则关联查询 owner_room_rel 表获取房屋关联的人员信息。

十二、注意事项

  • 该接口需要认证，需在请求头携带有效的 Authorization Token。
  • 分页参数 page 和 row 需合理设置，避免大数据量查询影响性能。