HC小区接口文档

保存业主车辆信息接口文档

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

一、接口名称

保存业主车辆信息

二、接口描述

该接口用于为业主绑定车辆信息,包括车牌号、车辆类型、车位信息等,并支持设置车辆属性。

三、接口路径

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

四、请求方法

POST

五、请求头

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

六、请求参数

6.1 请求体参数(JSON格式)

参数名称 必填 类型 描述 示例
communityId String 小区ID "123456789"
ownerId String 业主ID "1001"
carNum String 车牌号 "京A12345"
carType String 车辆类型(PRIMARY-主要车辆,MEMBER-成员车辆,TEMP-临时车辆) "PRIMARY"
psId String 车位ID "PS001"
leaseType String 租赁类型(MONTH-月租,默认值) "MONTH"
startTime 条件必填 String 开始时间(leaseType=MONTH时必填,格式:yyyy-MM-dd) "2023-01-01"
endTime 条件必填 String 结束时间(leaseType=MONTH时必填,格式:yyyy-MM-dd) "2023-12-31"
attrs Array 车辆属性列表 见下方示例

6.1.1 attrs 参数说明(可选)

参数名称 必填 类型 描述 示例
specCd String 属性编码 "1001"
value String 属性值 "白色"

七、返回值

7.1 返回值结构

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

八、示例请求

{
  "communityId": "123456789",
  "ownerId": "1001",
  "carNum": "京A12345",
  "carType": "PRIMARY",
  "psId": "PS001",
  "leaseType": "MONTH",
  "startTime": "2023-01-01",
  "endTime": "2023-12-31",
  "attrs": [
    {
      "specCd": "1001",
      "value": "白色"
    },
    {
      "specCd": "1002",
      "value": "SUV"
    }
  ]
}

九、示例响应

{
  "code": "0",
  "msg": "成功",
  "data": null
}

十、错误码

错误码 描述 可能原因
1001 小区ID不能为空 请求未包含 communityId
1002 业主ID不能为空 请求未包含 ownerId
1003 车牌号不能为空 请求未包含 carNum
1004 车辆类型不能为空 请求未包含 carType
1005 车位ID不能为空 请求未包含 psId
1006 该车位不是空闲状态 车位已被占用
1007 车辆已存在 车牌号已绑定其他车辆
1008 车辆在场,请出场后再办理月租车 临时车未出场

十一、业务逻辑说明

  1. 参数校验

    • 检查必填参数(communityIdownerIdcarNumcarTypepsId)是否为空。
    • 如果 leaseType=MONTH,检查 startTimeendTime 是否合法。
    • 检查车位是否空闲(状态为 F)。
    • 检查车牌号是否已绑定其他车辆(临时车除外)。
    • 如果车牌号是临时车,检查是否在场(未出场)。
  2. 数据处理

    • 生成车辆ID(carId)。
    • 设置默认值(如 leaseType=MONTHcarTypeCd=PRIMARY)。
    • 保存车辆信息(OwnerCarPo)。
    • 更新车位状态为出租(H)。
    • 保存车辆属性(attrs)。
  3. 数据库操作

    • 查询车位信息(ParkingSpaceDto)。
    • 插入车辆信息(OwnerCarPo)。
    • 更新车位状态(ParkingSpacePo)。
    • 插入车辆属性(OwnerCarAttrPo)。

十二、注意事项

  1. 时间格式startTimeendTime 必须为 yyyy-MM-dd 格式。
  2. 车位状态:仅空闲车位(state=F)可绑定车辆。
  3. 临时车处理:如果车牌号是临时车,需先出场才能绑定为月租车。
  4. 车辆属性attrs 可选,用于存储额外信息(如颜色、车型)。