HC小区接口文档

基础接口

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

资产接口

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

业主接口

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

费用接口

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

工单接口

报修接口 投诉接口

API 接口文档：添加单元

删除单元
查询单元
添加单元
修改单元

1. 接口名称

添加单元

2. 接口描述

用于外部系统向小区添加单元信息，包括单元编号、楼层数、电梯信息等。

3. 接口路径

POST http://{ip}:{port}/app/unit.saveUnit

4. 请求方法

POST

5. 请求头

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

6. 请求参数

6.1 请求体（JSON）

参数名称 必填 类型 描述 示例
communityId 是 String 小区 ID "2022081539020475"
floorId 是 String 楼栋 ID "732022081690440002"
unitNum 是 String 单元编号 "2"
layerCount 是 String 楼层数（需为整数） "2"
lift 是 String 电梯信息（1010 有电梯，2020 无电梯） "1010"
unitArea 否 String 单元面积（可选） "100"
remark 否 String 备注（可选） "测试单元"

7. 返回值

7.1 返回数据（JSON）

参数名称 类型 描述 示例
code int 返回码（0 成功，非 0 失败） 0
msg String 返回信息 "成功"

8. 示例请求

{
  "floorId": "732022081690440002",
  "unitNum": "2",
  "layerCount": "2",
  "lift": "1010",
  "remark": "2",
  "communityId": "2022081539020475",
  "unitArea": "100"
}

9. 示例响应

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

10. 错误码

错误码 错误信息 可能原因
非 0 失败 参数校验失败、单元已存在、数据库操作失败等

11. 业务逻辑说明

  1. 参数校验

    • 检查必填字段（communityId、floorId、unitNum、layerCount、lift）。
    • 检查 layerCount 是否为整数。
    • 检查 lift 是否为 1010（有电梯）或 2020（无电梯）。
    • 校验 floorId 是否属于该小区。
    • 检查单元编号 unitNum 是否已存在。

  2. 数据库操作

    • 生成 unitId（如未提供）。
    • 调用 unitV1InnerServiceSMOImpl.saveUnit() 保存单元信息。

  3. 返回结果

    • 成功返回 code=0，失败抛出异常并返回错误信息。

文档版本：1.0
最后更新：YYYY-MM-DD
作者：吴学文