HC小区接口文档

API 接口文档:删除楼栋

删除楼栋
修改楼栋
添加楼栋
查询楼栋

1. 接口名称

删除楼栋

2. 接口描述

用于外部系统删除指定小区内的楼栋信息。删除前会校验该楼栋下是否存在房屋或商铺,若存在则不允许删除。

3. 接口路径

http://{ip}:{port}/app/floor.deleteFloor

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 "123123"

7. 返回值

7.1 成功响应(200)

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

7.2 错误响应(400)

参数名称 类型 描述 示例
code int 错误码(非 0 表示失败) 1
msg String 错误信息 "请先删除楼栋下的房屋或者商铺"

8. 示例请求

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

9. 示例响应

9.1 成功响应

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

9.2 错误响应

{
  "code": 1,
  "msg": "请先删除楼栋下的房屋或者商铺"
}

10. 业务逻辑说明

  1. 参数校验

    • 检查 floorId 和 communityId 是否为空。
    • 检查该楼栋下是否存在房屋或商铺,若存在则拒绝删除。
  2. 删除操作

    • 调用 floorV1InnerServiceSMOImpl.deleteFloor 删除楼栋。
    • 同时删除该楼栋下的所有单元(Unit)。
  3. 事务管理

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

11. 注意事项

  • 删除前必须确保楼栋下无房屋或商铺,否则会返回错误。
  • 该接口涉及数据库删除操作,请谨慎调用。

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