HC小区接口文档

API接口文档:修改单元信息

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

一、接口名称

修改单元信息接口

二、接口描述

用于外系统修改小区楼栋单元的基本信息,包括单元编号、楼层数、电梯配置、单元面积等。

三、接口路径

http://{ip}:{port}/app/unit.updateUnit

四、请求方法

POST

五、请求头

参数名称 必填 类型 描述
Authorization String 用户认证 Token(通过登录接口获取)
app-id String 应用 ID(由系统 dev 账户分配)
transaction-id String 请求流水号(格式:1000000000 + YYYYMMDDhhmmss + 6位序列,不可重复)
sign String 签名(基于请求参数和密钥生成)
req-time String 请求时间(格式:YYYYMMDDhhmmss

六、请求参数(Body)

参数名称 必填 类型 长度限制 描述 可选值
communityId String 30 小区 ID -
floorId String 30 楼栋 ID -
unitId String 30 单元 ID -
unitNum String 30 单元编号(如 "1单元") -
layerCount String 30 楼层总数(需为有效数字) -
lift String 30 电梯配置 1010(有电梯)
2020(无电梯)
unitArea String 30 单元面积(平方米) -
remark String - 备注信息 -
userId String - 操作人用户 ID -

请求示例(JSON)

{
  "communityId": "2022081539020475",
  "floorId": "732022081690440002",
  "unitId": "123123",
  "unitNum": "2",
  "layerCount": "2",
  "lift": "1010",
  "unitArea": "2",
  "remark": "2单元"
}

七、返回值

参数名称 必填 类型 描述
code int 返回码(0 成功,其他失败)
msg String 返回信息(如“成功”)

响应示例(JSON)

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

八、错误码说明

错误码 描述 可能原因
0 成功 -
非0 失败 参数校验失败、数据库操作异常等
自定义 具体错误信息(如“单元总层数据无效”) 参见接口校验逻辑或异常提示

九、业务逻辑说明

  1. 参数校验

    • 检查必填字段(communityIdfloorIdunitIdunitNumlayerCountlift)。
    • 验证 layerCount 是否为有效数字。
    • 验证 lift 是否为 10102020
    • 校验 floorIdunitId 是否属于指定小区。
  2. 数据库操作

    • 调用 unitV1InnerServiceSMOImpl.updateUnit 更新单元信息。
  3. 事务管理

    • 使用 @Java110Transactional 确保数据一致性。

十、注意事项

  1. 需确保 communityIdfloorIdunitId 的关联关系正确。
  2. unitArea 未传,数据库可能保留原值或设为默认值(取决于实现)。
  3. 操作人 userId 可选,但建议传入以记录操作日志。

文档版本:1.0
最后更新日期:YYYY-MM-DD