HC小区接口文档

基础接口

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

门禁

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

道闸

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

更新车辆信息接口文档

一、接口名称

更新车辆信息

二、接口描述

用于更新业主或租户的车辆信息，包括车牌号、车辆类型、租赁类型等。

三、接口路径

http://ip:port/iot/api/ownerCar.UpdateOwnerCar

四、请求方法

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 "123456789"
carNum 是 String 车牌号 "京A12345"
carId 是 String 车辆ID "1001"
memberId 是 String 业主/租户ID "2001"
carType 是 String 车辆类型（CAR_TYPE_MEMBER 或 CAR_TYPE_TEMP） "CAR_TYPE_MEMBER"
leaseType 否 String 租赁类型（默认 LEASE_TYPE_MONTH） "LEASE_TYPE_MONTH"
startTime 否 String 开始时间（格式 YYYY-MM-DD，非月租车必填） "2023-01-01"
endTime 否 String 结束时间（格式 YYYY-MM-DD，非月租车必填） "2023-12-31"

七、返回值

7.1 返回值（JSON格式）

参数名称 类型 描述
code String 返回码（0 成功，非 0 失败）
msg String 返回信息
data Object 返回数据（通常为空）

八、示例请求

POST /iot/api/ownerCar.UpdateOwnerCar
Headers:
{
  "Authorization": "Bearer xxxxxx",
  "app-id": "micro-community",
  "transaction-id": "100000000020230101120000000001",
  "sign": "xxxxxx",
  "req-time": "20231001120000"
}
Body:
{
  "communityId": "123456789",
  "carNum": "京A12345",
  "carId": "1001",
  "memberId": "2001",
  "carType": "CAR_TYPE_MEMBER",
  "leaseType": "LEASE_TYPE_MONTH"
}

九、示例响应

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

十、业务逻辑说明

  1. 参数校验

    • 校验 communityId、carNum、carId、memberId、carType 是否为空。
    • 校验车辆是否存在且未被释放（psId 不为空或 -1）。
    • 如果是临时车辆（非 CAR_TYPE_MEMBER），必须绑定车位（psId 不能为空）。

  2. 默认值处理

    • 如果未提供 leaseType，默认设为 LEASE_TYPE_MONTH。
    • 如果 leaseType 不是月租，自动设置 startTime 为当前时间，endTime 为 2037-01-01。

  3. 数据库操作

    • 调用 IOwnerCarV1InnerServiceSMO.updateOwnerCar 更新车辆信息。
    • 返回操作结果（成功或失败）。

十一、错误码

错误码 描述
0 成功
非 0 失败（具体错误信息见 msg）