HC小区接口文档

编辑业主车辆信息接口文档

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

一、接口名称

编辑业主车辆信息

二、接口描述

该接口用于修改业主车辆信息,包括车牌号、车辆类型、租赁类型等。如果车辆是成员车辆(CAR_TYPE_MEMBER),则不会更新其时间信息。

三、接口路径

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

四、请求方法

POST

五、请求头

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

六、请求参数

6.1 请求体参数(JSON格式)

参数名称 必填 类型 描述
communityId String 小区ID
carNum String 车牌号
carId String 车辆ID
memberId String 业主/成员ID
carType String 车辆类型(CAR_TYPE_MEMBER:成员车辆,其他:业主车辆)
leaseType String 租赁类型(默认:LEASE_TYPE_MONTH)
startTime String 开始时间(格式:YYYY-MM-DD)
endTime String 结束时间(格式:YYYY-MM-DD)

七、返回值

7.1 响应格式(JSON)

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

八、示例请求

POST /app/owner.editOwnerCar HTTP/1.1
Host: localhost:8080
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
app-id: micro-community
transaction-id: 100000000020240101120000123456
sign: 3a5f7c9d1b2e4f6a8c0d9e7f5a3b1c2
req-time: 20240101120000
Content-Type: application/json

{
  "communityId": "123456789",
  "carNum": "京A12345",
  "carId": "10001",
  "memberId": "20001",
  "carType": "1001",
  "leaseType": "2001",
  "startTime": "2024-01-01",
  "endTime": "2025-01-01"
}

九、示例响应

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

十、业务逻辑说明

  1. 参数校验:检查 communityIdcarNumcarIdmemberIdcarType 是否为空。
  2. 车辆信息查询:根据 carIdmemberId 查询车辆信息,确保车辆存在且未被释放(psId 不为 -1)。
  3. 默认值处理:如果未提供 leaseType,则默认为 LEASE_TYPE_MONTH
  4. 更新车辆信息:调用 IOwnerCarV1InnerServiceSMO.updateOwnerCar 更新车辆信息。
  5. 成员车辆时间更新:如果车辆类型不是 CAR_TYPE_MEMBER,则更新关联成员车辆的时间信息。

十一、错误码说明

  • 参数缺失:返回错误提示,如 "未包含小区ID"
  • 车辆不存在:返回 "未找到车辆信息"
  • 车位已释放:返回 "车位已经被释放,不允许修改车辆信息"
  • 更新失败:返回 "修改数据失败"

十二、注意事项

  • 如果车辆是成员车辆(CAR_TYPE_MEMBER),不会更新其时间信息。
  • 如果未提供 startTimeendTime,系统不会自动填充默认值。
  • 该接口需要事务支持(@Java110Transactional),确保数据一致性。

这份文档涵盖了接口的所有关键信息,包括请求、响应、业务逻辑和错误处理。如果需要进一步调整或补充,请告诉我!