HC小区接口文档

API 接口文档:删除业主信息

查询业主
修改业主
添加业主
删除业主

1. 接口名称

删除业主信息

2. 接口描述

该接口用于第三方系统(如招商系统)删除业主信息。删除前会校验业主是否绑定房屋、车位或成员,确保数据完整性。

3. 接口路径

POST http://{ip}:{port}/app/owner.deleteOwner

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 格式)
参数名称 必填 类型 描述 示例
memberId String 业主 ID "123123123"
communityId String 小区 ID "2022121921870161"
ownerTypeCd String 业主类型(默认 "1001" 表示业主) "1001"

示例请求体:

{
    "memberId": "123123123",
    "communityId": "2022121921870161"
}

7. 返回值

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

示例响应:

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

8. 业务逻辑说明

  1. 参数校验

    • 检查 memberIdcommunityId 是否为空。
    • 如果业主类型是 "1001"(业主),则检查是否绑定房屋或车位,若有则不允许删除。
    • 检查业主是否有未删除的成员,若有则不允许删除。
  2. 删除操作

    • 删除业主信息(t_owner 表)。
    • 删除业主与 App 用户的绑定关系(t_owner_app_user 表)。
    • 删除业主属性信息(t_owner_attr 表)。
    • 删除业主账户信息(t_account 表)。
  3. 事务管理

    • 使用 @Java110Transactional 确保数据一致性,任一操作失败则回滚。

9. 错误码说明

错误码 描述 可能原因
0 成功 操作成功
非0 失败 参数错误、数据校验失败、数据库操作失败

10. 示例请求(CURL)

curl -X POST \
  http://127.0.0.1:8080/app/owner.deleteOwner \
  -H 'Authorization: Bearer xxxxxx' \
  -H 'app-id: xxx' \
  -H 'transaction-id: 100000000020231010120000000001' \
  -H 'req-time: 20231010120000' \
  -H 'sign: xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "memberId": "123123123",
    "communityId": "2022121921870161"
  }'

11. 注意事项

  • 删除业主前需确保已解绑房屋、车位和成员。
  • 接口支持事务回滚,确保数据一致性。
  • 请求头需携带正确的认证信息。

该文档符合 RESTful API 规范,涵盖请求、响应、业务逻辑及错误处理,可直接用于开发对接。