HC小区接口文档

基础接口

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

资产接口

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

业主接口

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

费用接口

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

工单接口

报修接口 投诉接口

API 接口文档：添加楼栋

删除楼栋
修改楼栋
添加楼栋
查询楼栋

1. 接口名称

添加楼栋

2. 接口描述

用于外部系统向社区管理系统添加楼栋信息。

3. 接口路径

POST http://{ip}:{port}/app/floor.saveFloor

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. 请求参数（Body）

参数名称 必填 类型 长度 描述 示例
communityId 是 String 30 小区 ID "2022081539020475"
name 是 String 64 楼栋名称 "2号楼"
floorNum 是 String 64 楼栋编号 "2"
floorArea 否 String 64 楼栋面积 "22"
seq 否 int 11 排序 22
remark 否 String - 备注 "2号楼"
userId 是 String - 操作人 ID "123456"

7. 返回值

参数名称 类型 描述
code int 返回码（0 表示成功，其他表示失败）
msg String 返回信息（成功或错误描述）

8. 示例请求

{
  "communityId": "2022081539020475",
  "name": "2号楼",
  "floorNum": "2",
  "floorArea": "22",
  "seq": 22,
  "remark": "2号楼",
  "userId": "123456"
}

9. 示例响应

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

10. 错误码

错误码 描述
1 楼栋编号已存在
1 楼栋名称已存在
1 保存楼栋失败

11. 业务逻辑说明

  1. 参数校验：
    • 检查 name、floorNum、communityId、userId 是否为空。
    • 检查 floorNum 是否已存在（同一小区内不允许重复）。
    • 检查 name 是否已存在（同一小区内不允许重复）。
  2. 数据存储：
    • 生成 floorId（格式：FLOOR_ + 随机ID）。
    • 将数据存入数据库（FloorPo 表）。
  3. 返回结果：
    • 成功返回 code=0，失败返回错误信息。

文档生成依据：

  • 基于 SaveFloorCmd.java 代码分析。
  • 符合 RESTful API 规范。
  • 标注必填参数和可选参数。
  • 包含示例请求和响应。