HC小区接口文档

API 接口文档:删除单元

删除单元
查询单元
添加单元
修改单元

1. 接口名称

删除单元

2. 接口描述

用于外部系统删除小区内的单元信息。删除前会校验单元是否存在、是否属于指定小区,并检查单元下是否有房屋(若有房屋则不允许删除)。

3. 接口路径

http://{ip}:{port}/app/unit.deleteUnit

4. 请求方法

POST

5. 请求头

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

6. 请求参数

6.1 请求体(JSON)

参数名称 必填 类型 描述 示例
communityId String 小区 ID "2022081539020475"
floorId String 楼栋 ID "123456"
unitId String 单元 ID "123123"

7. 返回值

7.1 返回格式(JSON)

参数名称 类型 描述 示例
code int 返回码(0 表示成功,其他表示失败) 0
msg String 返回信息 "成功"

8. 示例请求

{
  "communityId": "2022081539020475",
  "floorId": "123456",
  "unitId": "123123"
}

9. 示例响应

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

10. 错误码

错误码 错误信息 可能原因
非 0 "传入小区楼ID不是该小区的楼" floorId 不属于 communityId
非 0 "传入单元不是该小区的楼的单元" unitId 不属于 floorId
非 0 "单元下存在房屋 请先删除房屋" 该单元下仍有房屋数据
非 0 "删除单元失败" 数据库操作失败

11. 业务逻辑说明

  1. 参数校验

    • 检查 communityIdfloorIdunitId 是否存在。
    • 校验 floorId 是否属于 communityId
    • 校验 unitId 是否属于 floorId
    • 检查单元下是否有房屋(若有则不允许删除)。
  2. 数据库操作

    • 调用 unitV1InnerServiceSMOImpl.deleteUnit 删除单元数据。
  3. 事务管理

    • 使用 @Java110Transactional 确保数据一致性。

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