HC小区接口文档

添加员工接口文档

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

一、接口名称

添加员工

二、接口描述

外部系统通过此接口添加员工,需要物业管理员账号登录(系统会根据管理员登录信息自动获取storeId)

三、接口路径

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

四、请求方法

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 请求体参数

参数名称 必填 类型 长度 描述 示例值
orgId String 30 组织ID "102022091988250052"
orgName String 64 组织名称 "演示物业 / 件部"
name String 64 员工姓名 "张三"
sex String 64 性别 0女 1男 "0"
email String 64 邮箱 "231@qq.com"
tel String 11 手机号 "13800138000"
address String 64 地址 "北京市朝阳区"
relCd String 64 岗位编码 "1000"
photo String - 照片 ""
idCard String 18 身份证号 "110101199003077777"

岗位编码说明:

  • 1000: 普通员工
  • 2000: 部门经理
  • 3000: 部门副经理
  • 4000: 部门组长
  • 5000: 分公司总经理
  • 6000: 分公司副总经理
  • 7000: 总经理助理
  • 8000: 总公司总经理
  • 9000: 总公司副总经理

七、返回值

7.1 返回值结构

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

八、示例请求

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

九、示例响应

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

十、业务逻辑说明

  1. 验证阶段:

    • 检查用户是否已登录(通过storeId判断)
    • 验证员工手机号是否已存在(员工手机号作为登录账号,不能重复)
  2. 数据处理阶段:

    • 生成用户ID
    • 添加用户基本信息
    • 设置默认密码(从系统配置获取并MD5加密)
    • 保存员工与组织关系
    • 保存员工岗位信息
    • 保存员工照片(如果有)
  3. 数据库操作:

    • 保存用户信息到user表
    • 保存用户属性到user_attr表(如身份证号)
    • 保存员工与店铺关系到store_user表
    • 保存员工与组织关系到org_staff_rel表
    • 保存照片关系到file_rel表(如果有照片)

十一、注意事项

  1. 必须使用物业管理员账号登录调用此接口
  2. 手机号(tel)作为员工登录账号,必须唯一
  3. 系统会自动设置默认密码(从系统配置获取)
  4. 如果提供了照片(photo),需要确保照片已上传到文件服务