HC小区接口文档

基础接口

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

门禁

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

道闸

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

查询停车场接口文档

一、接口名称

查询停车场列表

二、接口描述

用于查询指定小区内的停车场信息，支持分页查询，并返回停车场的基本信息及对应的二维码访问链接。

三、接口路径

http://{ip}:{port}/iot/api/parkingArea.listParkingArea

四、请求方法

GET

五、请求头

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

六、请求参数

6.1 查询参数

参数名称 必填 类型 描述
communityId 是 String 小区ID
page 否 int 页码（默认1）
row 否 int 每页记录数（默认10）

七、返回值

7.1 返回数据结构

参数名称 类型 描述
code int 返回码，0表示成功，非0表示失败
msg String 返回消息
data Array 停车场列表
page int 当前页码
records int 当前页记录数
total int 总记录数

7.2 data 字段详情

参数名称 类型 描述
paId String 停车场ID
num String 停车场名称
communityId String 所属小区ID
createTime String 创建时间
extPaId String 外部系统关联ID
remark String 备注
statusCd String 状态（0-正常）
typeCd String 类型编码
findQrcodeUrl String 车辆查询二维码链接

八、示例请求

请求URL 

http://127.0.0.1:8080/iot/api/parkingArea.listParkingArea?page=1&row=10&communityId=102023021386560001

九、示例响应

{
    "code": 0,
    "data": [
        {
            "communityId": "102023021386560001",
            "createTime": "2023-08-23 09:07:59",
            "extPaId": "1",
            "num": "2",
            "paId": "102023082384250002",
            "page": -1,
            "records": 0,
            "remark": "1",
            "row": 0,
            "statusCd": "0",
            "total": 0,
            "typeCd": "1001",
            "findQrcodeUrl": "http://example.com/#/pages/car/findCarInParkingArea?communityId=102023021386560001&paId=102023082384250002"
        }
    ],
    "msg": "成功",
    "page": 0,
    "records": 1,
    "rows": 0,
    "total": 1
}

十、业务逻辑说明

  1. 参数校验：

    • 检查 communityId 是否为空。
    • 校验分页参数 page 和 row 是否合法。

  2. 数据查询：

    • 调用 IParkingAreaV1InnerServiceSMO.queryParkingAreasCount 获取总记录数。
    • 调用 IParkingAreaV1InnerServiceSMO.queryParkingAreas 获取分页数据。

  3. 生成二维码链接：

    • 为每个停车场生成一个用于查询车辆的二维码链接 findQrcodeUrl。

  4. 返回结果：

    • 封装分页数据，返回给前端。

十一、注意事项

  • 必须传入 communityId，否则接口会返回错误。
  • 分页参数 page 和 row 可选，默认 page=1，row=10。
  • 二维码链接 findQrcodeUrl 可用于车主自助查询车辆信息。