HC小区接口文档

API 接口文档:查询停车位信息

查询车位
删除车位
修改车位
添加车位

1. 接口名称

查询停车位信息

2. 接口描述

该接口用于查询社区内的停车位信息,支持分页查询,并可根据车牌号查询关联的停车位。

3. 接口路径

parkingSpace.queryParkingSpaces(Java110Cmd 服务编码)

4. 请求方法

POST(基于 Java110Cmd 框架,默认使用 POST 方式)

5. 请求头

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

6. 请求参数

6.1 请求体(JSON)

参数名称 必填 类型 描述 示例
page Integer 当前页码 1
row Integer 每页记录数 10
communityId String 社区 ID "123456789"
carNum String 车牌号(可选,用于查询关联车位) "京A12345"
state String 车位状态(可选,如 "S" 表示出售,"H" 表示出租) "S"
psId String 停车位 ID(可选) "PS001"

  • 如果 carNum 参数存在,则优先按车牌号查询车位信息。
  • state 参数支持 "SH" 值,表示同时查询出售("S")和出租("H")状态的车位。

7. 返回值

7.1 响应格式(JSON)

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

data 结构

参数名称 类型 描述
total Integer 总记录数
records Integer 总页数
parkingSpaces List<ApiParkingSpaceDataVo> 停车位列表

ApiParkingSpaceDataVo 结构

参数名称 类型 描述
psId String 停车位 ID
num String 车位编号
area String 车位面积
state String 车位状态("S" 出售,"H" 出租)
communityId String 社区 ID
carNum String 关联车牌号(如果有)

8. 示例请求

8.1 查询所有停车位(分页)

{
  "page": 1,
  "row": 10,
  "communityId": "123456789"
}

8.2 按车牌号查询停车位

{
  "page": 1,
  "row": 10,
  "communityId": "123456789",
  "carNum": "京A12345"
}

9. 示例响应

9.1 成功响应

{
  "code": "0",
  "msg": "success",
  "data": {
    "total": 50,
    "records": 5,
    "parkingSpaces": [
      {
        "psId": "PS001",
        "num": "A001",
        "area": "15㎡",
        "state": "S",
        "communityId": "123456789",
        "carNum": "京A12345"
      },
      {
        "psId": "PS002",
        "num": "A002",
        "area": "12㎡",
        "state": "H",
        "communityId": "123456789",
        "carNum": null
      }
    ]
  }
}

9.2 错误响应

{
  "code": "1001",
  "msg": "请求参数缺失:communityId 不能为空",
  "data": null
}

10. 业务逻辑说明

  1. 参数校验
    • 检查 pagerowcommunityId 是否为空,并验证是否为有效数字。
  2. 查询逻辑
    • 如果传入 carNum,则先查询 OwnerCarDto 获取关联的停车位 ID,再查询 ParkingSpaceDto
    • 否则,直接查询 ParkingSpaceDto 并分页返回。
  3. 状态过滤
    • 如果 state="SH",则转换为 ["S", "H"] 数组查询。

11. 数据库操作

  • IParkingSpaceInnerServiceSMO
    • queryParkingSpacesCount():查询停车位总数。
    • queryParkingSpaces():查询停车位列表。
  • IOwnerCarInnerServiceSMO
    • queryOwnerCars():根据车牌号查询车主车辆信息。

文档版本:v1.0
最后更新:2023-10-10