HC小区接口文档

删除业主接口文档

一、接口名称

删除业主

二、接口描述

第三方系统(如招商系统)调用此接口删除业主信息。如果该业主存在成员或绑定房屋,则不允许删除。

三、接口路径

http://{ip}:{port}/iot/api/owner.deleteOwner

四、请求方法

POST

五、请求头

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

六、请求参数

6.1 请求体参数(JSON格式)

参数名称 必填 类型 描述 示例
memberId 是 String 业主ID "123123123"
communityId 是 String 小区ID "2022121921870161"
ownerTypeCd 否 String 业主类型(默认1001) "1001"

七、返回值

7.1 返回数据(JSON格式)

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

八、业务逻辑说明

  1. 参数校验:

    • 检查 memberId 和 communityId 是否为空。
    • 如果 ownerTypeCd 不是 1001(业主成员),则直接返回。
    • 检查该业主是否存在成员,如果存在则不允许删除。
    • 检查该业主是否绑定房屋,如果绑定则不允许删除。
  2. 删除操作:

    • 调用 ownerV1InnerServiceSMOImpl.deleteOwner 删除业主信息。
    • 调用 syncAccessControlBMOImpl.syncDeleteAccessControl 同步删除门禁权限。

九、示例请求

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

十、示例响应

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

十一、错误情况

  • code ≠ 0:删除失败,具体原因见 msg 字段。
  • 异常情况:
    • 如果业主存在成员,返回错误 "请先删除业主下的成员"。
    • 如果业主绑定房屋,返回错误 "删除失败,删除前请先解绑房屋信息"。

数据库操作说明

  1. 查询:

    • ownerInnerServiceSMOImpl.queryOwnerMembers 查询业主成员。
    • roomInnerServiceSMOImpl.queryRoomsByOwner 查询业主绑定的房屋。
  2. 删除:

    • ownerV1InnerServiceSMOImpl.deleteOwner 删除业主记录。
  3. 同步:

    • syncAccessControlBMOImpl.syncDeleteAccessControl 同步删除门禁权限。

该接口适用于物业管理、招商系统等需要删除业主信息的场景。