HC小区接口文档

API 接口文档:删除房屋

添加房屋
修改房屋
删除房屋
查询房屋

1. 接口名称

删除房屋

2. 接口描述

该接口用于删除房屋信息。在删除房屋前,系统会自动解绑该房屋与业主的绑定关系,并删除该房屋关联的所有费用记录(包括缴费记录、欠费记录等)。

3. 接口路径

POST http://{ip}:{port}/app/room.deleteRoom

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 "2022121921870161"
roomId String 房屋 ID "123123123123"
unitId String 单元 ID "unit123456"

示例请求体:

{
    "communityId": "2022121921870161",
    "roomId": "123123123123",
    "unitId": "unit123456"
}

7. 返回值

7.1 返回数据(JSON)

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

示例响应:

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

8. 业务逻辑说明

  1. 参数校验

    • 检查 communityIdroomIdunitId 是否为空。
    • 检查 unitId 是否属于该小区。
  2. 删除房屋

    • 调用 roomV1InnerServiceSMOImpl.deleteRoom() 删除房屋数据。
  3. 解绑业主关系

    • 查询该房屋绑定的业主关系(ownerRoomRelV1InnerServiceSMOImpl.queryOwnerRoomRels())。
    • 调用 ownerRoomRelV1InnerServiceSMOImpl.deleteOwnerRoomRel() 解绑所有关联的业主。
  4. 删除费用记录

    • 查询该房屋关联的所有费用(payFeeV1InnerServiceSMOImpl.queryPayFees())。
    • 删除缴费记录(payFeeDetailV1InnerServiceSMOImpl.deletePayFeeDetailNew())。
    • 删除费用(payFeeV1InnerServiceSMOImpl.deletePayFee())。
    • 删除欠费记录(reportOweFeeInnerServiceSMOImpl.deleteReportOweFee())。
    • 删除离散月数据(payFeeDetailMonthInnerServiceSMOImpl.deletePayFeeDetailMonth())。

9. 错误码

错误码 错误信息 可能原因
0 "成功" 操作成功
非0 "删除房屋失败" 数据库操作失败
-1 "传入单元ID不是该小区的单元" unitId 不属于该小区

10. 注意事项

  • 必须先解绑业主:如果房屋仍绑定业主,需先调用解绑接口,否则无法删除。
  • 级联删除:删除房屋会同时删除所有关联的费用记录,请谨慎操作。
  • 事务支持:该接口使用 @Java110Transactional 注解,确保数据一致性。

文档版本:v1.0
最后更新:2023-XX-XX
作者:吴学文