HC小区接口文档

API接口文档:删除业主成员

添加家庭成员
修改家庭成员
删除家庭成员
查询家庭成员

一、接口名称

删除业主成员

二、接口描述

第三方系统(如招商系统)调用此接口删除指定小区内的业主成员信息。

三、接口路径

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

四、请求方法

POST

五、请求头

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

六、请求参数

6.1 Body参数(JSON格式)
参数名称 必填 类型 长度限制 描述 示例值
communityId String 30 小区ID "2022121921870161"
memberId String 30 业主成员ID "123123123"
6.2 参数校验逻辑
  • 接口会验证 memberIdcommunityId 是否为空。
  • 检查当前用户是否有权限操作该业主成员(通过 userId 关联校验)。
  • 确保目标业主成员存在且唯一。

七、返回值

7.1 响应格式(JSON)
参数名称 类型 描述 示例值
code int 返回码(0成功,其他失败) 0
msg String 返回信息 "成功"
7.2 状态码说明
  • 0:删除成功。
  • 非0:失败(具体错误信息见 msg 字段)。

八、示例请求

POST /app/owner.deleteOwnerMember HTTP/1.1
Authorization: Bearer xxxxxx
app-id: micro-community
transaction-id: 100000000020231015120000000001
req-time: 20231015120000
sign: xxxxxxxxxxxxxxx

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

九、示例响应

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

十、业务逻辑说明

  1. 权限校验:通过 userId 验证操作者是否为合法用户。
  2. 数据查询:根据 memberIdcommunityId 查询业主成员信息,确保数据存在。
  3. 删除操作
    • 删除 owner 表中对应的业主成员记录。
    • 级联删除 owner_app_user 表中关联的APP用户绑定关系。
  4. 事务管理:通过 @Java110Transactional 注解保证操作的原子性。

十一、注意事项

  • 仅支持删除类型为 成员(OWNER_TYPE_CD_MEMBER) 的业主。
  • 若业主关联车辆或其他资产,需先解除关联再调用本接口。

文档版本:1.0
最后更新:2023-10-15
作者:吴学文