HC小区接口文档

基础接口

登陆 添加人员 修改人员 查询人员 删除人员

门禁

添加门禁 修改门禁 查询门禁 门禁开门 重启门禁 门禁授权 删除授权 查询授权 开门记录 删除门禁

道闸

查询停车场 删除车位 查询车位 添加车位 修改车位 添加车辆 修改车辆 删除车辆 查询车辆 查询道闸 开闸 关闸

修改业主信息接口文档

一、接口名称

修改业主信息

二、接口描述

第三方系统（如招商系统）同步业主信息，支持修改业主基本信息、人脸照片、属性信息，并同步门禁系统。

三、接口路径

http://{ip}:{port}/iot/api/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编码，用于同步门禁系统）
attrs 否 Array - 业主属性列表（可选）

6.2 attrs 参数结构（可选）

参数名称 必填 类型 长度 描述
attrId 否 String - 属性ID（新增时可不传，修改时必传）
specCd 否 String - 属性编码
value 否 String - 属性值

七、返回值

7.1 返回值结构（JSON格式）

参数名称 必填 类型 描述
code 是 int 返回码（0：成功，其他：失败）
msg 是 String 返回信息

八、示例请求

{
  "name": "王王",
  "link": "18909718888",
  "address": "张三",
  "sex": "0",
  "ownerTypeCd": "1001",
  "remark": "",
  "memberId": "123123123",
  "ownerPhoto": "",
  "idCard": "",
  "communityId": "2022121921870161",
  "attrs": [
    {
      "attrId": "123456",
      "specCd": "1001",
      "value": "测试属性"
    }
  ]
}

九、示例响应

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

十、业务逻辑说明

  1. 参数校验

    • 检查必填参数（memberId、name、link、sex、ownerTypeCd、communityId）。
    • 检查手机号、身份证号是否重复（若包含 * 则从数据库查询原值）。

  2. 修改业主信息

    • 更新业主基本信息（姓名、手机号、身份证号等）。
    • 若传 ownerPhoto，则更新人脸照片（存储至文件系统）。

  3. 同步门禁系统

    • 调用 syncAccessControlBMOImpl.syncAccessControl 同步门禁权限。

  4. 更新业主属性（可选）

    • 若传 attrs，则新增或修改业主属性。

十一、注意事项

  1. 手机号、身份证号去重：若 link 或 idCard 包含 *，则从数据库查询原值。
  2. 人脸照片存储：若 ownerPhoto 长度超过 512，则存储至文件系统并返回文件ID。
  3. 门禁同步：修改业主信息后自动同步门禁权限。

以上为完整的 API 接口文档，如有疑问可进一步补充说明。