HC小区接口文档

修改房屋

添加房屋
修改房屋
删除房屋
查询房屋

1. 修改房屋信息接口

1.1 接口描述

该接口用于修改房屋的基本信息,包括房号、层数、建筑面积等属性,同时支持修改房屋租赁信息。

1.2 接口路径

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

1.3 请求方法

POST

1.4 请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证token
app-id 是 String 应用ID
transaction-id 是 String 请求流水号
sign 是 String 签名
req-time 是 String 请求时间(YYYYMMDDhhmmss)

1.5 请求参数

1.5.1 请求体参数

参数名称 必填 类型 长度 描述 示例值
communityId 是 String 30 小区ID "2022121921870161"
roomId 是 String 30 房屋ID "123123123123"
roomNum 是 String 64 房号 "88488"
layer 是 String 12 层数 "1"
unitId 是 String 30 单元ID "123123123"
builtUpArea 是 String 12 建筑面积 "110"
section 否 String 12 房屋个数 "0"
apartment 否 String 12 固定值"10102" "10102"
feeCoefficient 否 String 12 算费系数(默认1) "1.00"
roomSubType 否 String 12 房屋类型(110住宅/120办公室/119宿舍) "110"
roomArea 否 String 12 室内面积 "110"
roomRent 否 String 12 租金(办公室/宿舍时使用) "0"
remark 否 String 512 备注 "sdf"
state 否 String - 房屋状态 "已出租"
startTime 条件必填 String - 起租时间(state为已出租时必填) "2023-01-01"
endTime 条件必填 String - 截租时间(state为已出租时必填) "2023-12-31"
attrs 否 Array - 房屋属性列表 见示例

1.6 返回值

参数名称 类型 描述 示例值
code int 返回码(0成功) 0
msg String 返回信息 "成功"

1.7 示例请求

{
    "roomNum": "88488",
    "layer": "1",
    "unitId": "123123123",
    "section": "0",
    "apartment": "10102",
    "builtUpArea": "110",
    "feeCoefficient": "1.00",
    "roomId": "123123123123",
    "remark": "sdf",
    "roomSubType": "110",
    "roomArea": "110",
    "roomRent": "0",
    "communityId": "2022121921870161",
    "state": "已出租",
    "startTime": "2023-01-01",
    "endTime": "2023-12-31",
    "attrs": [
        {
            "specCd": "1001",
            "value": "属性值1"
        },
        {
            "attrId": "2001",
            "specCd": "1002",
            "value": "属性值2"
        }
    ]
}

1.8 示例响应

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

1.9 业务逻辑说明

  1. 参数校验:

    • 必填字段校验(roomId, communityId, roomNum, layer, builtUpArea)
    • 金额格式校验(builtUpArea, feeCoefficient)
    • 租赁时间校验(起租时间不能大于截租时间)
    • 单元ID有效性校验(必须属于指定小区)
  2. 核心业务处理:

    • 更新房屋基本信息
    • 处理房屋属性(新增/修改属性)
    • 更新租赁信息(当state为"已出租"时)
    • 同步数据到IOT系统
  3. 数据库操作:

    • 更新room表记录
    • 新增/更新room_attr表记录
    • 更新owner_room_rel表租赁信息
  4. 特殊处理:

    • 当apartment1值为10-80时,自动设置section值(1-8)
    • 房屋状态为"已出租"时必须提供起止时间

1.10 注意事项

  1. 建筑面积(builtUpArea)和算费系数(feeCoefficient)必须为合法的金额格式
  2. 起租时间和截租时间格式必须为"YYYY-MM-DD"
  3. 房屋类型roomSubType的取值:
    • 110:住宅
    • 120:办公室
    • 119:宿舍
  4. 修改属性时,attrId为空表示新增属性,否则为修改现有属性