HC小区接口文档

API 接口文档:修改物业公司信息

添加物业
修改物业
删除物业
查询物业

1. 接口名称

修改物业公司信息

2. 接口描述

该接口用于更新物业公司的基本信息,包括公司名称、地址、法人、成立日期等。同时,如果物业公司关联的管理员用户和组织信息存在,也会同步更新。

3. 接口路径

POST http://{ip}:{port}/app/property.updateProperty

4. 请求方法

POST

5. 请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证 Token(Base Token)
app-id 是 String 应用 ID(由系统分配)
transaction-id 是 String 请求流水号(格式:1000000000+YYYYMMDDhhmmss+6位序列)
sign 是 String 签名
req-time 是 String 请求时间(格式:YYYYMMDDhhmmss)

6. 请求参数

6.1 请求体参数(JSON 格式)
参数名称 必填 类型 长度 描述
storeId 是 String 30 物业公司编号
name 否 String 64 物业公司名称
nearbyLandmarks 否 String 64 地标(如“XX公园旁”)
tel 否 String 11 物业管理员电话(作为管理员账号)
address 否 String 255 公司地址
corporation 否 String 64 法人代表
foundingTime 否 String 10 成立日期(格式:YYYY-MM-DD)
6.2 参数说明
  • 必填参数:storeId(物业公司编号)必须提供,否则接口会返回错误。
  • 可选参数:其他字段可根据需要更新,未提供的字段不会修改。

7. 返回值

7.1 返回格式(JSON)
参数名称 类型 描述
code int 返回码(0 表示成功,非 0 表示失败)
msg String 返回信息(如“成功”或错误描述)
7.2 状态码说明
状态码 描述
0 操作成功
非 0 操作失败(具体错误信息见 msg)

8. 示例请求

{
  "storeId": "102022083062960025",
  "name": "培训物业公司",
  "address": "培训物业公司",
  "tel": "18909715555",
  "corporation": "无",
  "foundingTime": "2022-08-01",
  "nearbyLandmarks": "123"
}

9. 示例响应

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

10. 业务逻辑说明

  1. 更新物业公司信息:
    • 根据 storeId 更新物业公司基本信息(name, address, tel 等)。
  2. 更新法人信息(如果 corporation 提供):
    • 检查是否已存在法人信息,不存在则新增,存在则更新。
  3. 更新成立日期(如果 foundingTime 提供):
    • 检查是否已存在成立日期信息,不存在则新增,存在则更新。
  4. 同步更新管理员用户和组织名称(如果 name 提供):
    • 更新关联的管理员用户名称(UserPo)。
    • 更新关联的组织名称(OrgPo)。

11. 注意事项

  • 事务支持:该接口使用 @Java110Transactional 注解,确保数据一致性。
  • 错误处理:如果更新失败(如数据库操作返回影响行数 <1),会抛出 CmdException 并返回错误信息。
  • 参数校验:storeId 必须提供,否则会返回错误。

文档版本:1.0
最后更新:2023-10-12
作者:吴学文
联系方式:928255095@qq.com