HC小区接口文档

API 接口文档:删除车位信息

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

1. 接口名称

删除车位(Delete Parking Space)

2. 接口描述

该接口用于删除社区内的车位信息。仅当车位状态为 空闲(STATE_FREE) 时才能删除,如果是 子母车位,需检查关联车位是否处于空闲状态。

3. 接口路径

parkingSpace.deleteParkingSpace(Java110Cmd 编码)

4. 请求方法

POST

5. 请求头

参数名称 必填 类型 描述
Authorization String 用户认证 Token(Base Token)
app-id String 应用 ID,由系统分配
transaction-id String 请求流水号(格式:1000000000+YYYYMMDDhhmmss+6位序列
sign String 请求签名
req-time String 请求时间(YYYYMMDDhhmmss

6. 请求参数

6.1 请求体(JSON)

参数名称 必填 类型 描述 示例
psId String 车位 ID "123456"
communityId String 社区 ID "10001"
state String 车位状态(必须为 STATE_FREE "F"

校验规则:

  • 如果车位是 子母车位(TYPE_CD_SON_MOTHER),需检查关联车位是否处于 出租(STATE_HIRE)已售(STATE_SELL) 状态,如果是则不允许删除。

7. 返回值

7.1 返回数据(JSON)

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

8. 示例请求

POST /api/parkingSpace.deleteParkingSpace
Headers:
{
  "Authorization": "Bearer xxxxxx",
  "app-id": "1001",
  "transaction-id": "100000000020230101120000000001",
  "sign": "xxxxxx",
  "req-time": "20230101120000"
}
Body:
{
  "psId": "123456",
  "communityId": "10001",
  "state": "F"
}

9. 示例响应

成功响应:

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

失败响应(车位非空闲):

{
  "code": "1001",
  "msg": "车位不是空闲,不能做删除",
  "data": null
}

失败响应(子母车位非空闲):

{
  "code": "1002",
  "msg": "子母车位非空闲",
  "data": null
}

10. 业务逻辑说明

  1. 参数校验

    • 检查 psIdcommunityId 是否为空。
    • 检查车位状态是否为 STATE_FREE
    • 如果是 子母车位,检查关联车位是否处于 出租已售 状态。
  2. 删除逻辑

    • 如果是普通车位,直接删除。
    • 如果是子母车位,检查关联车位状态后删除。
  3. 数据库操作

    • 调用 IParkingSpaceV1InnerServiceSMO.deleteParkingSpace() 执行删除操作。

文档版本:1.0
最后更新:2023-10-01