HC小区接口文档

基础接口

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

门禁

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

道闸

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

道闸设备列表查询接口文档

一、接口名称

道闸设备列表查询

二、接口描述

该接口用于查询社区内的道闸设备列表信息，支持分页查询，并返回设备在线状态等信息。

三、接口路径

http://ip:port/iot/api/barrier.listBarrier

四、请求方法

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
page 否 Integer 页码，默认为1
row 否 Integer 每页记录数，默认为10
paId 否 String 停车场区域ID（可选）

七、返回值

7.1 返回值结构

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

7.2 data对象结构

参数名称 类型 描述
totalPage Integer 总页数
records Integer 总记录数
barriers List 道闸设备列表

7.3 BarrierDto对象结构

参数名称 类型 描述
barrierId String 道闸ID
barrierName String 道闸名称
communityId String 小区ID
machineCode String 设备编码
heartbeatTime String 心跳时间
stateName String 设备状态名称（"设备在线"或"设备离线"）
locationTypeCd String 位置类型
locationObjId String 位置对象ID
remark String 备注

八、示例请求

GET /iot/api/barrier.listBarrier?communityId=702020082134730001&page=1&row=10
Headers:
  Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
  app-id: 1001
  transaction-id: 100000000020230101120000000001
  sign: 5a8f8f8f8f8f8f8f8f8f8f8f8f8f8f8f
  req-time: 20231001120000

九、示例响应

{
  "code": "0",
  "msg": "成功",
  "data": {
    "totalPage": 2,
    "records": 15,
    "barriers": [
      {
        "barrierId": "120020082134730001",
        "barrierName": "南门入口道闸",
        "communityId": "702020082134730001",
        "machineCode": "DZ001",
        "heartbeatTime": "2023-09-21 10:15:30",
        "stateName": "设备在线",
        "locationTypeCd": "1000",
        "locationObjId": "800020082134730001",
        "remark": "南门主入口"
      },
      {
        "barrierId": "120020082134730002",
        "barrierName": "北门出口道闸",
        "communityId": "702020082134730001",
        "machineCode": "DZ002",
        "heartbeatTime": "2023-09-20 18:30:45",
        "stateName": "设备离线",
        "locationTypeCd": "1000",
        "locationObjId": "800020082134730002",
        "remark": "北门出口"
      }
    ]
  }
}

十、业务逻辑说明

  1. 参数验证：

    • 必须包含communityId参数
    • 验证分页参数(page, row)

  2. 查询逻辑：

    • 如果传入了paId(停车场区域ID)，会先查询该区域关联的所有道闸设备ID
    • 根据查询条件获取道闸设备列表和总数
    • 计算设备在线状态（根据最后心跳时间判断，2分钟内为在线）

  3. 返回处理：

    • 返回分页信息和设备列表
    • 每个设备包含在线状态信息

十一、注意事项

  1. 设备在线状态是根据最后心跳时间自动计算的
  2. 分页参数如果不传，默认page=1，row=10
  3. 需要有效的认证token才能访问该接口