HC小区接口文档

API接口文档：添加业主成员

1. 接口名称

添加业主成员（Save Owner Member）

2. 接口描述

该接口用于第三方系统（如招商系统）同步业主信息到物业管理平台，支持添加业主或家庭成员，并可上传人脸照片用于门禁系统。

3. 接口路径

POST http://{ip}:{port}/app/owner.saveOwnerMember

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格式）

参数名称	必填	类型	长度限制	描述
communityId	是	String	30	小区ID
name	是	String	64	业主姓名
roomName	是	String	64	房屋信息（格式：楼栋-单元-房屋，如 `1-1-1001`）
link	否	String	11	业主手机号（未填写时系统自动生成）
idCard	否	String	30	身份证号
address	否	String	512	地址
sex	是	String	12	性别（`1`：男，`0`：女）
ownerTypeCd	是	String	12	成员类型（`1001`：业主，`2002`：家庭成员）
remark	否	String	512	备注
ownerId	是	String	30	业主ID（业主填 `-1`，家庭成员需填写关联的业主ID）
ownerPhoto	否	String	-	人脸照片Base64编码（用于门禁系统）
ownerPhotoUrl	否	String	500	人脸照片URL（与`ownerPhoto`二选一）
msgCode	否	String	-	短信验证码（需配合`link`使用，系统校验开关开启时必填）
attrs	否	Array	-	扩展属性列表（格式见下方示例）

6.2 参数说明

必填校验：name、sex、ownerId、communityId 为必填字段。
手机号校验：若系统配置 USER_VALIDATE=ON，会校验手机号是否重复。
图片限制：ownerPhotoUrl 长度不超过500字符。

6.3 扩展属性（attrs）示例

{
  "attrs": [
    {
      "specCd": "1001",  // 属性编码
      "value": "VIP"     // 属性值
    }
  ]
}

7. 返回值

参数名称	类型	描述
code	int	返回码（`0`：成功）
msg	String	返回信息（如“成功”）

8. 示例请求

POST /app/owner.saveOwnerMember
Headers: 
  Authorization: Bearer xxxxxx
  app-id: hc-micro-community
  transaction-id: 100000000020231015142359000001
  req-time: 20231015142359
  sign: xxxxxx

Body:
{
  "name": "王五",
  "roomName": "1-1-1001",
  "link": "18909718888",
  "sex": "1",
  "ownerTypeCd": "1001",
  "ownerId": "-1",
  "communityId": "2022121921870161",
  "ownerPhotoUrl": "http://example.com/photo.jpg",
  "attrs": [
    {
      "specCd": "1001",
      "value": "VIP"
    }
  ]
}

9. 示例响应

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

10. 业务逻辑说明

数据校验：
- 校验必填字段、手机号重复性、图片地址长度。
- 若开启短信验证（SMS_SEND_SWITCH=ON），校验 msgCode。
数据存储：
- 生成唯一 memberId，保存业主信息（OwnerPo）。
- 保存扩展属性（OwnerAttrPo）。
账号生成：
- 调用 generatorOwnerUserBMOImpl 自动生成业主登录账号。

11. 数据库操作

插入表：owner（业主信息）、owner_attr（扩展属性）。
关联服务：短信验证（ISmsInnerServiceSMO）、文件存储（IFileInnerServiceSMO）。

12. 注意事项

家庭成员需关联有效 ownerId。
人脸照片支持Base64或URL，但需确保系统存储服务可用。

基础接口

资产接口

业主接口

费用接口

工单接口

API接口文档：添加业主成员

1. 接口名称

2. 接口描述

3. 接口路径

4. 请求方法

5. 请求头

6. 请求参数

6.1 请求体参数（JSON格式）

6.2 参数说明

6.3 扩展属性（attrs）示例

7. 返回值

8. 示例请求

9. 示例响应

10. 业务逻辑说明

11. 数据库操作

12. 注意事项