HC小区接口文档

基础接口

登陆接口 接口签名 员工接口

资产接口

小区接口 物业接口 楼栋接口 单元接口 房屋接口 交房 退房 车位接口 车辆接口

业主接口

业主接口 家庭成员 查询房屋认证 认证审核 账户接口 撤销账户明细

费用接口

费用项接口 创建费 查询费用 缴费接口 结束费用 缴费记录 水电抄表

工单接口

报修接口 投诉接口

API接口文档：业主房屋关系绑定

一、接口名称

业主房屋关系绑定

二、接口描述

该接口用于实现业主与房屋的绑定关系，对应后台的“业主入驻房屋”功能。主要功能包括：

  1. 建立业主与房屋的关联关系
  2. 更新房屋状态（如已入住、已交房等）
  3. 触发业主信息更新（用于同步相关数据）

三、接口路径

http://{ip}:{port}/app/room.sellRoom

四、请求方法

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 -
state 是 String 12 房屋状态 2001（已入住）
2003（已交房）
2005（已装修）
2004（未入住）
2008（空闲）
2009（装修中）
startTime 否 String - 绑定开始时间（默认当前时间） 格式：YYYY-MM-DD HH:mm:ss
endTime 否 String - 绑定结束时间（默认2037-01-01 00:00:00） 格式：YYYY-MM-DD HH:mm:ss

七、返回值

7.1 响应体参数（JSON格式）

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

八、示例请求

请求体

{
    "ownerId": "121231",
    "state": "2001",
    "roomId": "123123",
    "communityId": "2022121921870161",
    "startTime": "2023-01-01 12:00:00",
    "endTime": "2030-01-01 12:00:00"
}

请求头示例

Authorization: Bearer xxxxxx
app-id: micro-community
transaction-id: 100000000020230101120000000001
sign: xxxxxx
req-time: 20230101120000

九、示例响应

成功响应

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

失败响应（参数缺失）

{
    "code": 1,
    "msg": "小区ID不能为空"
}

十、业务逻辑说明

  1. 参数校验：验证必填字段（communityId、roomId、ownerId、state）是否为空。
  2. 默认值处理：
    • 若未提供startTime，默认使用当前时间。
    • 若未提供endTime，默认设置为2037-01-01 00:00:00。
  3. 核心操作：
    • 绑定关系：调用ownerRoomRelV1InnerServiceSMOImpl.saveOwnerRoomRel保存业主与房屋的关联关系。
    • 更新房屋状态：调用roomV1InnerServiceSMOImpl.updateRoom更新房屋状态。
    • 触发业主信息同步：调用ownerV1InnerServiceSMOImpl.updateOwner更新业主信息（用于触发数据总线同步）。

十一、注意事项

  1. 状态码有效性：state必须为预定义的6种状态之一。
  2. 业主唯一性：ownerId需对应系统中唯一的业主记录。
  3. 幂等性：重复调用接口会覆盖原有绑定关系。

以上为完整的API文档，符合RESTful规范，涵盖请求、响应、业务逻辑及示例。