HC小区接口文档

基础接口

登陆接口 接口签名 员工接口

资产接口

小区接口 物业接口 楼栋接口 单元接口 房屋接口 交房 退房 车位接口 车辆接口

业主接口

业主接口 家庭成员 查询房屋认证 认证审核 账户接口 撤销账户明细

费用接口

费用项接口 创建费 查询费用 缴费接口 结束费用 缴费记录 水电抄表

工单接口

报修接口 投诉接口

查询业主车辆信息接口文档

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

一、接口名称

查询业主车辆信息

二、接口描述

该接口用于查询小区内业主的车辆信息，支持分页查询，并可关联查询车位信息、房屋信息及物联网设备状态。

三、接口路径

http://ip:port/app/owner.queryOwnerCars

四、请求方法

GET

五、请求头

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

六、请求参数

6.1 查询参数

参数名称 必填 类型 描述
page 是 Integer 当前页码
row 是 Integer 每页记录数
communityId 是 String 小区ID
num 否 String 车位编号（模糊查询）
areaNum 否 String 车位区域编号（模糊查询）
carTypeCds 否 String 车辆类型（多个用逗号分隔，如 1,2,3）
userId 否 String 用户ID（用于权限校验）

七、返回值

7.1 返回数据结构

参数名称 类型 描述
code Integer 返回码，0 表示成功，非 0 表示失败
msg String 返回信息
data Object 返回数据
data.total Integer 总记录数
data.records List<OwnerCarDto> 车辆信息列表

7.2 OwnerCarDto 字段说明

字段名称 类型 描述
carId String 车辆ID
carNum String 车牌号
carBrand String 车辆品牌
carTypeCd String 车辆类型编码
psId String 车位ID
ownerId String 业主ID
memberId String 成员ID（用于物联网设备关联）
link String 联系方式（可能脱敏）
areaNum String 车位区域编号
num String 车位编号
parkingType String 车位类型
roomName String 关联房屋信息（如 1-1-101）
iotStateName String 物联网设备状态
iotRemark String 物联网设备备注

八、示例请求

请求URL 

GET http://ip:port/app/owner.queryOwnerCars?page=1&row=10&communityId=123456&carTypeCds=1,2

请求头示例 

Authorization: Bearer xxxxxx
app-id: micro-community
transaction-id: 100000000020231201143456000001
sign: xxxxxx
req-time: 20231201143456

九、示例响应

成功响应 

{
  "code": 0,
  "msg": "成功",
  "data": {
    "total": 15,
    "records": [
      {
        "carId": "1001",
        "carNum": "京A12345",
        "carBrand": "Tesla",
        "carTypeCd": "1",
        "psId": "2001",
        "ownerId": "3001",
        "memberId": "4001",
        "link": "138****1234",
        "areaNum": "A区",
        "num": "A001",
        "parkingType": "固定车位",
        "roomName": "1-1-101",
        "iotStateName": "已同步",
        "iotRemark": "设备在线"
      }
    ]
  }
}

失败响应 

{
  "code": 1,
  "msg": "请求中未包含communityId信息",
  "data": null
}

十、业务逻辑说明

  1. 参数校验：检查 page、row、communityId 是否有效。
  2. 车位查询：如果传入 num 或 areaNum，先查询车位信息，再关联查询车辆。
  3. 车辆查询：根据条件分页查询车辆信息。
  4. 关联信息补充：
    • 车位信息（areaNum、num、parkingType）
    • 房屋信息（roomName）
    • 物联网设备状态（iotStateName、iotRemark）
  5. 数据脱敏：若无权限，联系方式 link 会被脱敏处理。

十一、数据库操作

  • 查询 hc_parking_space 表（车位信息）
  • 查询 hc_owner_car 表（车辆信息）
  • 查询 hc_owner_room_rel 表（业主房屋关联）
  • 查询 hc_room 表（房屋信息）
  • 查询 iot_machine_translate 表（物联网设备状态）

十二、注意事项

  • 分页参数 page 和 row 必须为整数。
  • communityId 是必填项，否则返回错误。
  • 若 row ≥ 20，则不会查询关联信息（房屋、车位、物联网状态）。