HC小区接口文档

查询员工信息接口文档

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

一、接口名称

查询员工信息

二、接口描述

根据员工名称、手机号、组织ID等条件查询员工信息,返回员工的基本信息、所属组织、岗位、联系方式等数据。

三、接口路径

http://{ip}:{port}/app/query.staff.infos

四、请求方法

GET

五、请求头

参数名称 必填 类型 描述
store-id String 商户ID,用于权限校验
user-id String 当前操作用户ID,用于权限校验

六、请求参数

6.1 查询参数

参数名称 必填 类型 描述
page Integer 当前页码(从1开始)
row Integer 每页记录数
orgId String 组织ID,用于筛选特定组织的员工
staffName String 员工名称,支持模糊查询

七、返回值

7.1 响应结构

参数名称 类型 描述
code int 返回码,0表示成功,非0表示失败
msg String 返回信息,如“成功”或错误描述
total int 总记录数
records int 总页数
staffs List<ApiStaffDataVo> 员工数据列表

7.2 staffs 数据结构

参数名称 类型 描述
userId String 员工ID
name String 员工姓名
orgName String 所属组织名称
orgId String 所属组织ID
relCdName String 岗位名称
tel String 手机号
address String 地址
email String 邮箱
initials String 姓名首字母
urls List<String> 员工头像URL列表
leaders List<StoreStaffLeaderDto> 上级领导信息

八、示例请求

请求URL

http://127.0.0.1:8080/app/query.staff.infos?page=1&row=10&orgId=842022090369280030&staffName=韩

请求头

store-id: 102022090382820025
user-id: 302022091908980026

九、示例响应

响应数据

{
  "code": 0,
  "msg": "成功",
  "total": 2,
  "records": 1,
  "staffs": [
    {
      "userId": "302022091908980026",
      "name": "韩余",
      "orgName": "晋邻通智慧社区 / 安保部",
      "orgId": "842022090369280030",
      "relCdName": "普通员工",
      "tel": "15033304901",
      "address": "changzhi",
      "email": "123@126.com",
      "initials": "H",
      "urls": ["img/20220919/5d258a09-0cea-407b-9da5-93da98a93760.jpg"],
      "leaders": [
        {
          "leaderId": "302022090645120164",
          "leaderName": "王勇",
          "leaderType": "部门经理"
        }
      ]
    },
    {
      "userId": "302022090609300172",
      "name": "韩俞",
      "orgName": "晋邻通智慧社区 / 安保部",
      "orgId": "842022090369280030",
      "relCdName": "部门组长",
      "tel": "17633305226",
      "address": "长治",
      "email": "sxjltwy@163.com",
      "initials": "H",
      "urls": ["img/20220906/98ff9c83-606e-4f1a-8f40-fbcdbb00c784.jpg"]
    }
  ]
}

十、业务逻辑说明

  1. 权限校验

    • 校验请求头中的 store-iduser-id
    • 非管理员用户只能查询自己所属组织架构下的员工
  2. 数据查询

    • 根据 orgIdstaffName 筛选员工
    • 查询员工所属组织信息
    • 查询员工头像信息(文件关联表)
    • 查询员工的上级领导信息
  3. 数据处理

    • 计算姓名首字母(用于前端排序)
    • 拼接完整组织路径(如“总公司 / 技术部 / 开发组”)
  4. 分页返回

    • 按照 pagerow 参数分页返回数据

十一、注意事项

  1. 必填参数:pagerowstore-id(请求头)
  2. 管理员可查看所有员工,普通员工只能查看自己所在组织及下级组织的员工
  3. 员工头像通过 FileRel 表关联查询,relTypeCd="12000" 表示员工头像