HC小区接口文档

API接口文档:修改小区信息

添加小区
修改小区
删除小区
查询小区

一、接口名称

修改小区信息

二、接口描述

该接口用于修改小区的基本信息,包括小区名称、地址、地理位置、收费信息等。同时支持修改小区的扩展属性(如社区编码等)。


三、接口路径

http://{ip}:{port}/app/community.updateCommunity

四、请求方法

POST

五、请求头

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

六、请求参数

6.1 请求体(JSON 格式)

必填参数

参数名称 必填 类型 描述 示例值
communityId String 小区编码 "2022092293190329"
name String 小区名称 "api接口小区1"
address String 小区地址 "天津省天津市和平区..."
nearbyLandmarks String 附近地标(如公园旁) "23"

可选参数

参数名称 必填 类型 描述 示例值
cityCode String 地区编码 "120101"
mapX String 经度 "101.33"
mapY String 纬度 "101.33"
payFeeMonth int 收费周期(月) 12
feePrice int 收费价格(单位:元) 0
tel String 客服电话 "18909711443"

扩展属性(attrs)(可选)

用于修改或新增小区的扩展属性,如社区编码等。

参数名称 必填 类型 描述 示例值
attrs Array 小区属性列表 [{"specCd": "9329000004", "value": "123123"}]

七、返回值

7.1 响应格式(JSON)

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

八、示例请求

8.1 请求示例(修改小区基本信息)

{
  "communityId": "2022092293190329",
  "name": "api接口小区1",
  "address": "天津省天津市和平区api接口小区",
  "nearbyLandmarks": "23",
  "cityCode": "120101",
  "mapX": "101.33",
  "mapY": "101.33",
  "payFeeMonth": 12,
  "feePrice": 0,
  "tel": "18909711443"
}

8.2 请求示例(修改小区+扩展属性)

{
  "communityId": "2022092293190329",
  "name": "api接口小区1",
  "address": "天津省天津市和平区api接口小区",
  "nearbyLandmarks": "23",
  "attrs": [
    {
      "specCd": "9329000004",
      "value": "123123",
      "attrId": "112022092280950341"
    }
  ]
}

九、示例响应

9.1 成功响应

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

9.2 失败响应

{
  "code": 1,
  "msg": "小区ID不能为空"
}

十、业务逻辑说明

  1. 参数校验

    • 校验 communityIdnameaddressnearbyLandmarks 是否为空。
    • 校验 attrs 中的必填属性(如 specCd)。
  2. 数据库操作

    • 更新小区基本信息(community 表)。
    • 如果存在 attrs,则更新或新增小区属性(building_community_attr 表)。
    • 如果修改了小区名称,同步更新关联的 role_community 表中的小区名称。
  3. 事务管理

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

十一、注意事项

  1. 必填字段communityIdnameaddressnearbyLandmarks 必须提供。
  2. 扩展属性:如果 attrId 为空或以 - 开头,则视为新增属性;否则为修改。
  3. 权限控制:需携带有效的 Authorization Token。