HC小区接口文档

API接口文档:修改业主信息

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

一、接口名称

修改业主信息

二、接口描述

该接口用于第三方系统(如招商系统)同步业主信息,支持修改业主的基本信息、联系方式、身份证号、人脸照片等数据,并更新关联的账户和App用户信息。

三、接口路径

http://{ip}:{port}/app/owner.editOwner

四、请求方法

POST

五、请求头

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

六、请求参数

6.1 请求体参数(JSON格式)

参数名称 必填 类型 长度限制 描述
communityId String 30 小区ID
name String 64 业主姓名
link String 11 业主手机号(需唯一,若包含*则忽略)
idCard String 30 业主身份证号(需唯一,若包含*则忽略)
address String 512 业主住址
sex String 12 性别:1(男)/ 0(女)
ownerTypeCd String 12 业主类型:1001(业主)/ 2002(家庭成员,需传ownerId
remark String 512 备注信息
memberId String 30 业主ID(唯一标识,必传)
ownerPhoto String - 业主人脸照片(Base64编码,用于门禁系统)
ownerPhotoUrl String 500 人脸照片URL(长度不超过500字符)
attrs JSONArray - 业主自定义属性列表(格式见下方说明)

attrs字段说明(可选)

[
  {
    "attrId": "属性ID(新增时传空或负值)",
    "specCd": "属性编码",
    "value": "属性值"
  }
]

七、返回值

7.1 响应体参数

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

八、示例请求

请求示例

{
  "name": "王五",
  "link": "18909718888",
  "address": "北京市海淀区",
  "sex": "0",
  "ownerTypeCd": "1001",
  "memberId": "123123123",
  "idCard": "110101199001011234",
  "communityId": "2022121921870161",
  "ownerPhotoUrl": "https://example.com/face.jpg",
  "attrs": [
    {
      "attrId": "112233",
      "specCd": "OWNER_CAR_NUM",
      "value": "京A12345"
    }
  ]
}

响应示例

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

九、业务逻辑说明

  1. 参数校验

    • 校验必填字段(memberIdnamelinkcommunityId)。
    • 手机号和身份证号去敏(若含*则忽略)。
    • 检查手机号是否与其他业主重复。
  2. 数据更新

    • 修改业主基础信息(OwnerPo表)。
    • 更新关联账户的手机号和姓名(AccountPo表)。
    • 处理自定义属性(OwnerAttrPo表,新增或修改)。
    • 同步绑定的App用户手机号(OwnerAppUserPoUserPo表)。
  3. 事务控制

    • 使用@Java110Transactional注解保证操作原子性。

十、注意事项

  1. ownerTypeCd2002(家庭成员),需确保ownerId有效。
  2. 图片地址(ownerPhotoUrl)超过500字符会报错。
  3. 手机号重复校验严格,需与现有数据比对。

以上为完整API文档,符合RESTful规范,标注了必填/可选参数及数据类型。