HC小区接口文档

修改员工信息接口文档

查询员工
保存员工
删除员工
重置密码
查询组织

一、接口名称

修改员工信息

二、接口描述

该接口用于外部系统修改员工信息。需要物业管理员账号登录,系统会根据管理员登录信息自动获取storeId。

三、接口路径

http://{ip}:{port}/app/user.staff.modify

四、请求方法

POST

五、请求头

参数名称 必填 类型 描述
Authorization String 用户认证token Base token 通过登录接口获取token
app-id String 应用ID 系统dev账户分配
transaction-id String 请求流水号 不能重复 1000000000+YYYYMMDDhhmmss+6位序列
sign String 签名
req-time String 请求时间 YYYYMMDDhhmmss

六、请求参数

6.1 请求体参数

参数名称 必填 类型 长度 描述 示例
staffId String 30 员工ID "123123"
name String 64 员工姓名 "张三"
tel String 11 手机号 "13800138000"
userId String 30 用户ID "123123"
orgId String 30 组织ID "102022091988250052"
orgName String 64 组织名称 "演示物业 / 件部"
sex String 64 性别(0女 1男) "0"
email String 64 邮箱 "231@qq.com"
address String 64 地址 "北京市朝阳区"
relCd String 64 岗位编码(1000普通员工 2000部门经理 3000部门副经理 4000部门组长 5000分公司总经理 6000分公司副总经理 7000总经理助理 8000总公司总经理 9000总公司副总经理) "1000"
photo String - 头像照片(base64编码) -
idCard String - 身份证号 "110101199003077654"

七、返回值

7.1 响应体

参数名称 类型 长度 描述 示例
code int 11 返回编号(0成功 其他失败) 0
msg String 250 描述信息 "成功"

八、业务逻辑说明

  1. 参数验证

    • 验证必填参数(staffId, name, tel)是否存在
    • 验证修改的员工是否属于当前管理员所在公司
    • 验证手机号是否已存在(不能重复)
  2. 头像处理

    • 如果包含photo参数且不为空,处理头像图片
    • 如果是base64编码的图片,保存到文件系统
    • 更新或创建文件关联关系
  3. 员工信息更新

    • 更新用户基本信息(User表)
    • 更新身份证信息(UserAttr表)
    • 更新员工岗位信息(StoreUser表)
    • 更新组织关系(OrgStaffRel表)
  4. 事务处理

    • 所有更新操作在一个事务中执行,保证数据一致性

九、示例请求

{
  "userId": "123123",
  "orgId": "102022091988250052",
  "orgName": "演示物业 / 件部",
  "username": "张三",
  "sex": "0",
  "email": "231@qq.com",
  "tel": "13800138000",
  "address": "北京市朝阳区",
  "relCd": "1000",
  "photo": "",
  "name": "张三",
  "staffId": "123123"
}

十、示例响应

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

十一、注意事项

  1. 必须使用物业管理员账号登录
  2. 手机号不能重复
  3. 邮箱格式会进行验证
  4. 头像图片如果是base64编码,长度不能超过200个字符,否则会保存为文件
  5. 所有更新操作在一个事务中执行,任一操作失败会回滚所有操作