HC小区接口文档

API 接口文档:业主房屋关系解绑(ExitRoomCmd)


一、接口名称

业主房屋关系解绑

二、接口描述

该接口用于解除业主与房屋的绑定关系,对应后台的 "业主退房" 功能。

三、接口路径

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

四、请求方法

POST

五、请求头

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

六、请求参数

6.1 请求体(JSON 格式)

参数名称 必填 类型 长度 描述
communityId 是 String 30 小区 ID
roomId 是 String 30 房屋 ID
ownerId 是 String 30 业主 ID

七、返回值

7.1 返回数据(JSON 格式)

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

八、示例请求

8.1 请求示例

{
    "ownerId": "121231",
    "roomId": "123123",
    "communityId": "2022121921870161"
}

8.2 成功响应示例

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

8.3 失败响应示例

{
    "code": 1,
    "msg": "数据存在问题,业主和房屋对应关系不是一条"
}

九、业务逻辑说明

  1. 参数校验

    • 检查 communityId、ownerId、roomId 是否为空。
    • 检查业主与房屋的绑定关系是否存在。
  2. 数据库操作

    • 删除 owner_room_rel 表中的绑定关系。
    • 更新 room 表的状态(如果是商铺,则状态设为 STATE_SHOP_FREE,否则设为 2002)。
  3. 返回结果

    • 成功返回 code=0,失败返回错误码和错误信息。

十、注意事项

  1. 必填参数:communityId、ownerId、roomId 必须全部提供,否则请求失败。
  2. 数据一致性:如果业主与房屋的绑定关系不存在,会返回错误。
  3. 状态更新:房屋状态会根据 roomType 自动调整(商铺或普通房屋)。

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