HC小区接口文档

编辑楼栋

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

一、接口名称

编辑楼栋信息

二、接口描述

用于外部系统编辑楼栋信息,包括楼栋名称、编号、面积、排序等属性。

三、接口路径

http://{ip}:{port}/app/floor.editFloor

四、请求方法

POST

五、请求头

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

六、请求参数

6.1 请求体(JSON格式)

参数名称 必填 类型 长度 描述
floorId String 30 楼栋ID
name String 64 楼栋名称
floorNum String 64 楼栋编号
communityId String 30 小区ID
userId String - 操作用户ID
floorArea String 64 楼栋面积
seq Integer 11 排序序号
remark String - 备注信息

七、返回值

7.1 返回值(JSON格式)

参数名称 类型 描述
code int 返回码,0表示成功,非0表示失败
msg String 返回信息,描述操作结果

八、示例请求

请求体:

{
  "floorId": "123123",
  "name": "2号楼",
  "floorNum": "2",
  "communityId": "2022081539020475",
  "userId": "1001",
  "floorArea": "22",
  "seq": 22,
  "remark": "测试楼栋"
}

九、示例响应

成功响应:

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

失败响应(楼栋编号已存在):

{
  "code": 1,
  "msg": "楼栋编号已经存在"
}

十、业务逻辑说明

  1. 参数校验

    • 检查必填参数(floorIdnamefloorNumcommunityIduserId)是否存在。
    • 校验楼栋编号(floorNum)是否已存在(同一小区内不允许重复)。
  2. 数据更新

    • 将请求参数转换为 FloorPo 对象,调用 IFloorV1InnerServiceSMO.updateFloor 更新数据库。
    • 如果更新失败(返回影响行数 <1),抛出异常并返回错误信息。
  3. 事务管理

    • 使用 @Java110Transactional 注解确保数据操作的原子性。

十一、注意事项

  • 请求头中的 transaction-id 需保证唯一性,避免重复请求。
  • 修改楼栋编号时需确保新编号在当前小区内唯一。
  • 失败时返回的 codemsg 可用于前端错误提示。