员工管理

1. 获取员工列表（getEmployeeList）

前端： 谭海涛 后端： 陈明辉

url： /v1/homing/system/web/employee/page-list备注： WEB-员工管理-分页列表

typescript

//! 注意，TS版本4^
import type { GetEmployeeListReq, GetEmployeeListRes } from '@homing/web'

homingClient.getEmployeeList({
    mobile: '13800138000',
    nickname: '张三',
    orgId: 123,
    pageIndex: 1,
    pageRows: 10
}).then((res: any) => {
    console.log('员工列表数据', res.list);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
`mobile`	string	否	手机号
`orgId`	number	否	组织ID
`nickname`	string	否	昵称
`state`	number	否	状态	1: 启用, 0: 禁用
`pageIndex`	number	否	当前页码	默认 1
`pageRows`	number	否	每页条数	默认 10
`subTagFlag`	Boolean	否	是否需要获取标签

响应说明

字段名	类型	说明	备注
`list`	object	列表数据

list 字段说明

字段名	类型	说明
`employeeId`	number	员工标识
`employeeCode`	string	员工编号
`jobNumber`	string	工号
`nickname`	string	昵称
`avatar`	string	头像
`gender`	string	性别
`mobile`	string	手机号
`bizMail`	string	企业邮箱
`employeeStatus`	number	激活状态
`state`	number	状态
`userInfo`	object	用户基本信息
`orgInfo`	object	店铺基本信息
`roleInfos`	array	角色基本信息
`extattr`	JSON	扩展字段，如果有值请通过json解析目前包含certification：资格证书
`employeeTags`	array	员工标签
`positionInfos`	array	职位信息

pager 字段说明

字段名	类型	说明
`totalRows`	number	总记录数
`pageRows`	number	每页条数
`pageIndex`	number	当前页码
`totalPages`	number	总页数
`hasNextPage`	boolean	是否有下一页
`hasPrevPage`	boolean	是否有上一页

类型说明

typescript

// 员工标签
type EmployeeTags = {
   /** 标签标识 */
  tagCode: number;
  /** 标签名称 */
  tagName: string;
}[];

// 职位信息
type PositionInfo = {
  /** 职位标识 */
  positionId: string;
  /** 职位编码 */
  positionCode: string;
  /** 职位名称 */
  positionName: string;
  /** 职位分类 */
  positionType: string;
  /** 描述 */
  description: string;
  /** 显示排序 */
  sortValue: string;
  /** 状态 */
  state: string;
};

2. 获取员工列表-H5（getEmployeeListH5）

前端： 谭海涛
后端： 况俊飚
url： /v1/homing/system/h5/employee/list
备注： H5-员工管理-员工列表

typescript

homingClient.getEmployeeListH5().then((res: any) => {
  console.log('员工列表数据', res.list);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
`mobile`	string	否	手机号
`orgId`	number	否	组织ID
`nickname`	string	否	昵称
`state`	number	否	状态	（1-启用，0-禁用）
`roleNames`	string	否	角色名，支持模糊查询，多个角色名用英文逗号分隔
`positionCodes`	string	否	员工职位，通过组合数据HOMING_BIZ_SCENE_POSITION_MAP配置

响应说明

字段名	类型	说明	备注
`list`	object	列表数据

list 字段说明

字段名	类型	说明
`employeeId`	number	员工标识
`employeeCode`	string	员工编号
`jobNumber`	string	工号
`nickname`	string	昵称
`avatar`	string	头像
`gender`	string	性别
`mobile`	string	手机号
`bizMail`	string	企业邮箱
`employeeStatus`	number	激活状态
`state`	number	状态
`userInfo`	object	用户基本信息
`orgInfo`	object	店铺基本信息
`roleInfos`	array	角色基本信息
`employeeTags`	array	员工标签
`positionInfos`	array	职位信息

pager 字段说明

字段名	类型	说明
`totalRows`	number	总记录数
`pageRows`	number	每页条数
`pageIndex`	number	当前页码
`totalPages`	number	总页数
`hasNextPage`	boolean	是否有下一页
`hasPrevPage`	boolean	是否有上一页

3. 添加员工（addEmployee）

前端: 谭海涛
后端: 冀晋星
url: /v1/homing/system/web/employee/add
备注: WEB-员工管理-新增

typescript

//! 注意，TS版本4^
import type { AddEmployeeReq, AddEmployeeRes } from '@homing/web'

try {
    await client.addEmployee({
        nickname: '张三',
        mobile: '13800138000',
        orgId: 123,
        state: 1
    } as AddEmployeeReq);
    console.log('添加成功');
} catch (error: any) {
    console.log(error, '添加失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
`nickname`	string	是	昵称
`mobile`	string	是	手机号码
`orgId`	number	是	店铺id
`state`	number	是	状态
`jobNumber`	string	否	工号
`roleIds`	string	否	角色Id,多个用逗号隔开
`positionCodes`	string	否	职位id,多个用逗号隔开
`bizMail`	string	否	企业邮箱
`avatar`	string	否	头像
`region`	string	否	地区
`address`	string	否	地址详情
`joinDate`	string	否	入职日期
`leaveDate`	string	否	离职日期
`positionStatus`	string	否	职位状态
`workDescribe`	string	否	工作描述
`qrCode`	string	否	员工个人二维码
`extattr`	string \| Object	否	自定义字段
`readonly`	number	否	内置
`employeeStatus`	string	否	激活状态	'1' \| '2' \| '3' \| '4'
`gender`	string	否	性别	'0' \| '1' \| '2'
`registerSource`	string	否	注册来源	'1' \| '2' \| '3'

自定义字段说明：extattr

原始需要传入JSON，只要传入文档指定接收的key，即可通过Object的方式提交

typescript

// 范围外的值传递： JSON字符串传递
const extattr = JSON.stringify({
    key:[
        {a:1},
        {b:2}
    ]
})

// 预设的值传递：直接通过object传递
const extattr = {
    certification:[
        {
            path:"www.baidu.com",
            name:"帅哥证"
        }
    ]
}

字段名	类型	说明
`certification`	Array	用户资格证书
`certification[].path`	string	证书地址
`certification[].name`	string	证书名称

响应说明

字段名	类型	说明
`employeeId`	number	员工标识

4. 获取员工详情（getEmployeeInfo）

前端： 谭海涛
后端： 陈明辉
url： /v1/homing/system/web/employee/get
备注： WEB-员工管理-查询

typescript

//! 注意，TS版本4^
import type { GetEmployeeDetailReq, GetEmployeeDetailRes } from '@homing/web'

try {
    const data: GetEmployeeDetailRes = await client.getEmployeeInfo({
        employeeId: 123,
        orgId: 456,
        subTagFlag: true
    } as GetEmployeeDetailReq);
    console.log('调用成功', data);
} catch (error: any) {
    console.log(error, '调用失败' + error?.message);
}

参数说明

参数名	类型	必填	说明
`employeeId`	number	是	员工ID
`orgId`	number	是	机构ID
`subTagFlag`	boolean	是	是否需要获取标签

响应说明

字段名	类型	说明	备注
`employeeCode`	string	员工编号
`jobNumber`	string	工号
`tenantCode`	string	租户编码
`bizMail`	string	企业邮箱
`nickname`	string	昵称
`avatar`	string	头像
`region`	string	地区
`address`	string	地址详情
`joinDate`	string	入职日期
`leaveDate`	string	离职日期
`positionStatus`	string	职位状态
`workDescribe`	string	工作描述
`sourceType`	string	身份来源
`qrCode`	string	员工个人二维码
`extattr`	JSON	自定义字段	目前包含certification：资格证书
`readonly`	string	内置
`employeeStatus`	string	激活状态
`state`	number	状态
`createdBy`	string	创建人
`createdTime`	string	创建时间
`updatedBy`	string	更新人
`updatedTime`	string	更新时间
`userInfo`	object	用户基本信息
`orgInfo`	object	店铺基本信息
`roleInfos`	array	角色基本信息
`positionInfos`	array	职位信息
`gender`	string	性别
`employeeId`	number	员工标识
`employeeTags`	array	员工标签	资格认证跟职位

positionInfos 字段说明

字段名	类型	说明
`positionId`	string	职位标识
`positionCode`	string	职位编码
`positionName`	string	职位名称
`positionType`	string	职位分类
`description`	string	描述
`sortValue`	string	显示排序
`state`	string	状态

employeeTags 字段说明

字段名	类型	说明
`tagCode`	number	标签标识
`tagName`	string	标签名称

5. 更新员工信息（updateEmployeeInfo）

前端： 谭海涛
后端： 柏康
url： /v1/homing/system/web/employee/update
备注： WEB-员工管理-更新

typescript

//! 注意，TS版本4^
import type { UpdateEmployeeInfoReq, UpdateEmployeeInfoRes } from '@homing/web'

try {
    await client.updateEmployeeInfo({
        employeeId: 123456,
        nickname: '李四',
        jobNumber: 'EMP001',
        orgId: 789012,
        mobile: '13900139000',
        roleIds: '1,2,3',
        bizMail: 'lisi@company.com',
        gender: 1
    } as UpdateEmployeeInfoReq);
    console.log('更新成功');
} catch (error: any) {
    console.log(error, '更新失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
`employeeId`	number	是	员工标识
`orgId`	number	是	店铺ID
`nickname`	string	是	昵称
`jobNumber`	string	否	工号
`mobile`	string	是	手机号码
`roleIds`	string	否	角色Id,多个用逗号隔开
`bizMail`	string	否	企业邮箱
`gender`	number	是	性别	1: 男, 2: 女
`extattr`	string \| Object	否	自定义字段
`readonly`	number	否	内置
`employeeStatus`	string	否	激活状态	'1' \| '2' \| '3' \| '4'
`positionCodes`	string	否	职位id,多个用逗号隔开
`positionStatus`	string	否	职位状态
`workDescribe`	string	否	工作描述
`qrCode`	string	否	员工个人二维码

自定义字段说明：extattr

原始需要传入JSON，只要传入文档指定接收的key，即可通过Object的方式提交

typescript

// 范围外的值传递： JSON字符串传递
const extattr = JSON.stringify({
    key:[
        {a:1},
        {b:2}
    ]
})

// 预设的值传递：直接通过object传递
const extattr = {
    certification:[
        {
            path:"www.baidu.com",
            name:"帅哥证"
        }
    ]
}

字段名	类型	说明
`certification`	Array	用户资格证书
`certification[].path`	string	证书地址
`certification[].name`	string	证书名称

响应说明

字段名	类型	说明
`employeeId`	number	员工标识

6. 删除员工（removeEmployee）

前端： 谭海涛
后端： 胡伟
url： /v1/homing/system/web/employee/delete
备注： WEB-员工管理-删除

typescript

//! 注意，TS版本4^
import type { RemoveEmployeeReq } from '@homing/web'

homingClient.removeEmployee({
  employeeId: 123456,
  orgId: 789012
}).then((res: any) => {
  console.log('删除成功');
});

参数说明

参数名	类型	必填	说明	备注/枚举值
`employeeId`	number	是	员工ID
`orgId`	number	是	机构ID

响应说明

字段名	类型	说明
无

员工管理 ​

1. 获取员工列表（getEmployeeList） ​

参数说明 ​

响应说明 ​

2. 获取员工列表-H5（getEmployeeListH5） ​

参数说明 ​

响应说明 ​

3. 添加员工（addEmployee） ​

参数说明 ​

自定义字段说明：extattr ​

响应说明 ​

4. 获取员工详情（getEmployeeInfo） ​

参数说明 ​

响应说明 ​

positionInfos 字段说明 ​

employeeTags 字段说明 ​

5. 更新员工信息（updateEmployeeInfo） ​

参数说明 ​

自定义字段说明：extattr ​

响应说明 ​

6. 删除员工（removeEmployee） ​

参数说明 ​

响应说明 ​

员工管理

1. 获取员工列表（getEmployeeList）

参数说明

响应说明

2. 获取员工列表-H5（getEmployeeListH5）

参数说明

响应说明

3. 添加员工（addEmployee）

参数说明

自定义字段说明：extattr

响应说明

4. 获取员工详情（getEmployeeInfo）

参数说明

响应说明

positionInfos 字段说明

employeeTags 字段说明

5. 更新员工信息（updateEmployeeInfo）

参数说明

自定义字段说明：extattr

响应说明

6. 删除员工（removeEmployee）

参数说明

响应说明