员工管理 - Powered by MinDoc

创建/修改员工
上传人脸图片
查询组织下所有的员工
分页查询
根据ID查询
根据UserID查询
根据第三方code查询员工信息
简易新增或修改

创建/修改员工

接口地址:/openapi/employee

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "alias": "",
  "email": "",
  "empOrgPositionPfList": [
    {
      "endTime": "",
      "id": 0,
      "masterFlag": false,
      "orgId": 0,
      "positionId": 0,
      "startTime": ""
    }
  ],
  "id": 0,
  "userId":"",
  "idCardNo": "",
  "idCardType": "",
  "name": "",
  "phone": "",
  "resignedDate": "",
  "startDate": "",
  "status": false,
  "type": "",
  "specialCode":""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
open-platform Employee对象Req	保存员工信息	body	true	open-platform Employee对象Req	open-platform Employee对象Req
name	员工姓名		true	string
phone	手机号		true	string
type	员工类型。内部员工：in_side；外部员工：out_side		true	string
empOrgPositionPfList	员工组织岗位关联		true	array	open-platform EmpOrgPosition对象
masterFlag	是否是主职位		false	boolean
startTime	任职开始时间 yyyy-MM-dd		false	string
endTime	任职结束日期 yyyy-MM-dd		false	string
id	ID（新增的时候不传，传了视为修改）		false	integer
orgId	组织ID		false	integer
positionId	职位ID		false	integer
id	ID（新增的时候不传，传了视为修改）		false	integer(int64)
userId	用户id（新增的时候不传，传了视为修改与id二选一传参）		false	integer
email	邮箱		false	string
idCardNo	证件号码		false	string
idCardType	证件类型。身份证：ID_CARD；护照：PASSPORT		false	string
startDate	入职日期 yyyy-MM-dd		false	string(date-time)
resignedDate	离职日期 yyyy-MM-dd		false	string(date-time)
status	状态（true在职、false离职）		true	boolean
alias	别名		false	string
specialCode	第三方编码		false	string

响应状态:

状态码	说明	schema
200	OK	R«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string
successful	boolean

响应示例:

{
    "code": 0,
    "data": {
      "id":1,
      "userId": 0
    },
    "message": "",
    "successful": true
}

上传人脸图片

接口地址:/openapi/userFace/uploadFacePic

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
file	file	query	true	string
userId	userId	query	true	integer

响应状态:

状态码	说明	schema
200	OK	R«string»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	string
message	string
successful	boolean

响应示例:

{
    "code": 0,
    "data": "",
    "message": "",
    "successful": true
}

查询组织下所有的员工

接口地址:/openapi/employee/listByOrgId

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
orgId	orgId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«List«open-platform Employee对象»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		array	open-platform Employee对象Res
alias	别名	string
code	员工编码	string
email	邮箱	string
empOrgPositionPfList	员工组织岗位关联	array	open-platform EmpOrgPosition对象
endTime	任职结束日期 yyyy-MM-dd	string
id	ID（新增的时候不传，传了视为修改）	integer
masterFlag	是否是主职位	boolean
orgId	组织ID	integer
positionId	职位ID	integer
startTime	任职开始时间 yyyy-MM-dd	string
faceUrl	人脸图片，从user里面获取	string
id	员工ID	integer(int64)
idCardNo	证件号码	string
idCardType	证件类型	string
name	名称	string
phone	手机号	string
resignedDate	离职日期	string(date-time)
startDate	入职日期	string(date-time)
status	状态（true在职、false离职）	boolean
type	员工类型。内部员工：in_side；外部员工：out_side	string
userId	用户ID	integer(int64)
message		string
successful		boolean

响应示例:

{
    "code": 0,
    "data": [
        {
            "alias": "",
            "code": "",
            "email": "",
            "empOrgPositionPfList": [
                {
                    "endTime": "",
                    "id": 0,
                    "masterFlag": false,
                    "orgId": 0,
                    "positionId": 0,
                    "startTime": ""
                }
            ],
            "faceUrl": "",
            "id": 0,
            "idCardNo": "",
            "idCardType": "",
            "name": "",
            "phone": "",
            "resignedDate": "",
            "startDate": "",
            "status": false,
            "type": "",
            "userId": 0
        }
    ],
    "message": "",
    "successful": true
}

分页查询

接口地址:/openapi/employee/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "code": "",
  "name": "",
  "phone": "",
  "positionId": 0,
  "status": false,
  "specialCode":""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
open-platform EmployeePfRequest 对象	员工查询请求	body	true	open-platform EmployeePfRequest 对象	open-platform EmployeePfRequest 对象
code	员工编码		false	string
name	名称		false	string
phone	手机号		false	string
positionId	岗位ID		false	integer(int64)
status	状态（true在职、false离职）		false	boolean
specialCode	第三方编码		false	string
pageNo	pageNo	query	false	integer(int32)
pageSize	pageSize	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	R«open-platform 分页简单对象«open-platform Employee对象»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		open-platform 分页简单对象«open-platform Employee对象»	open-platform 分页简单对象«open-platform Employee对象»
current	当前页	integer(int64)
records	查询数据列表	array	open-platform Employee对象Res
alias	别名	string
code	员工编码	string
email	邮箱	string
empOrgPositionPfList	员工组织岗位关联	array	open-platform EmpOrgPosition对象
endTime	任职结束日期 yyyy-MM-dd	string
id	ID（新增的时候不传，传了视为修改）	integer
masterFlag	是否是主职位	boolean
orgId	组织ID	integer
positionId	职位ID	integer
startTime	任职开始时间 yyyy-MM-dd	string
faceUrl	人脸图片，从user里面获取	string
id	员工ID	integer
idCardNo	证件号码	string
idCardType	证件类型	string
name	名称	string
phone	手机号	string
resignedDate	离职日期	string
startDate	入职日期	string
status	状态（true在职、false离职）	boolean
type	员工类型。内部员工：in_side；外部员工：out_side	string
userId	用户ID	integer
size	每页显示条数	integer(int64)
total	总数	integer(int64)
message		string
successful		boolean

响应示例:

{
    "code": 0,
    "data": {
        "current": 0,
        "records": [
            {
                "alias": "",
                "code": "",
                "email": "",
                "empOrgPositionPfList": [
                    {
                        "endTime": "",
                        "id": 0,
                        "masterFlag": false,
                        "orgId": 0,
                        "positionId": 0,
                        "startTime": ""
                    }
                ],
                "faceUrl": "",
                "id": 0,
                "idCardNo": "",
                "idCardType": "",
                "name": "",
                "phone": "",
                "resignedDate": "",
                "startDate": "",
                "status": false,
                "type": "",
                "userId": 0
            }
        ],
        "size": 0,
        "total": 0
    },
    "message": "",
    "successful": true
}

根据ID查询

接口地址:/openapi/employee/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«open-platform Employee对象»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		open-platform Employee对象Res	open-platform Employee对象Res
alias	别名	string
code	员工编码	string
email	邮箱	string
empOrgPositionPfList	员工组织岗位关联	array	open-platform EmpOrgPosition对象
endTime	任职结束日期 yyyy-MM-dd	string
id	ID（新增的时候不传，传了视为修改）	integer
masterFlag	是否是主职位	boolean
orgId	组织ID	integer
positionId	职位ID	integer
startTime	任职开始时间 yyyy-MM-dd	string
faceUrl	人脸图片，从user里面获取	string
id	员工ID	integer(int64)
idCardNo	证件号码	string
idCardType	证件类型	string
name	名称	string
phone	手机号	string
resignedDate	离职日期	string(date-time)
startDate	入职日期	string(date-time)
status	状态（true在职、false离职）	boolean
type	员工类型。内部员工：in_side；外部员工：out_side	string
userId	用户ID	integer(int64)
message		string
successful		boolean

响应示例:

{
    "code": 0,
    "data": {
        "alias": "",
        "code": "",
        "email": "",
        "empOrgPositionPfList": [
            {
                "endTime": "",
                "id": 0,
                "masterFlag": false,
                "orgId": 0,
                "positionId": 0,
                "startTime": ""
            }
        ],
        "faceUrl": "",
        "id": 0,
        "idCardNo": "",
        "idCardType": "",
        "name": "",
        "phone": "",
        "resignedDate": "",
        "startDate": "",
        "status": false,
        "type": "",
        "userId": 0
    },
    "message": "",
    "successful": true
}

根据UserID查询

接口地址:/openapi/employee/UserId/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«open-platform Employee对象»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		open-platform Employee对象Res	open-platform Employee对象Res
alias	别名	string
code	员工编码	string
email	邮箱	string
empOrgPositionPfList	员工组织岗位关联	array	open-platform EmpOrgPosition对象
endTime	任职结束日期 yyyy-MM-dd	string
id	ID（新增的时候不传，传了视为修改）	integer
masterFlag	是否是主职位	boolean
orgId	组织ID	integer
positionId	职位ID	integer
startTime	任职开始时间 yyyy-MM-dd	string
faceUrl	人脸图片，从user里面获取	string
id	员工ID	integer(int64)
idCardNo	证件号码	string
idCardType	证件类型	string
name	名称	string
phone	手机号	string
resignedDate	离职日期	string(date-time)
startDate	入职日期	string(date-time)
status	状态（true在职、false离职）	boolean
type	员工类型。内部员工：in_side；外部员工：out_side	string
userId	用户ID	integer(int64)
message		string
successful		boolean

响应示例:

{
    "code": 0,
    "data": {
        "alias": "",
        "code": "",
        "email": "",
        "empOrgPositionPfList": [
            {
                "endTime": "",
                "id": 0,
                "masterFlag": false,
                "orgId": 0,
                "positionId": 0,
                "startTime": ""
            }
        ],
        "faceUrl": "",
        "id": 0,
        "idCardNo": "",
        "idCardType": "",
        "name": "",
        "phone": "",
        "resignedDate": "",
        "startDate": "",
        "status": false,
        "type": "",
        "userId": 0
    },
    "message": "",
    "successful": true
}

根据第三方code查询员工信息

接口地址:/openapi/employee/getBySpecialCode/{specialCode}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
specialCode	specialCode	path	true	String

响应状态:

状态码	说明	schema
200	OK	R«open-platform Employee对象»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		open-platform Employee对象Res	open-platform Employee对象Res
alias	别名	string
code	员工编码	string
email	邮箱	string
empOrgPositionPfList	员工组织岗位关联	array	open-platform EmpOrgPosition对象
endTime	任职结束日期 yyyy-MM-dd	string
id	ID（新增的时候不传，传了视为修改）	integer
masterFlag	是否是主职位	boolean
orgId	组织ID	integer
positionId	职位ID	integer
startTime	任职开始时间 yyyy-MM-dd	string
faceUrl	人脸图片，从user里面获取	string
id	员工ID	integer(int64)
idCardNo	证件号码	string
idCardType	证件类型	string
name	名称	string
phone	手机号	string
resignedDate	离职日期	string(date-time)
startDate	入职日期	string(date-time)
status	状态（true在职、false离职）	boolean
type	员工类型。内部员工：in_side；外部员工：out_side	string
userId	用户ID	integer(int64)
message		string
successful		boolean

响应示例:

{
    "code": 0,
    "data": {
        "alias": "",
        "code": "",
        "email": "",
        "empOrgPositionPfList": [
            {
                "endTime": "",
                "id": 0,
                "masterFlag": false,
                "orgId": 0,
                "positionId": 0,
                "startTime": ""
            }
        ],
        "faceUrl": "",
        "id": 0,
        "idCardNo": "",
        "idCardType": "",
        "name": "",
        "phone": "",
        "resignedDate": "",
        "startDate": "",
        "status": false,
        "type": "",
        "userId": 0
    },
    "message": "",
    "successful": true
}

简易新增或修改

接口地址:/openapi/simpleUser/addOrUpdateSimpleUser

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
jobNumber	工号	query	true	string
name	姓名	query	true	string
phoneNum	电话号码	query	false	string
file	人脸图片	file	false	string
orgId	任职组织id	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«Employee»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		Employee	Employee
alias	别名	string
avatarUrl	头像	string
code	员工编码	string
companyId	所属公司组织id	integer(int64)
companyName	所属公司	string
dataLevel	数据级别	string
deletedEmpOrgPositionIds	删除任职信息集合	array	integer
deptName	所属部门	string
email	邮箱	string
empOrgPositionList	员工组织岗位关联	array	EmpOrgPosition
avatarUrl	员工头像	string
companyId	公司ID	integer
companyName		string
deptId	部门ID	integer
deptName		string
employeeId	员工ID	integer
employeeName	员工名字	string
endTime	结束时间	string
masterFlag	是否是主职位	boolean
operateFlag	是否显示	boolean
orgCode		string
orgCodeStep		string
orgId	组织ID	integer
orgName	组织名称	string
orgType	组织类型	string
phone	员工电话	string
positionCode	岗位code	string
positionId	职位ID	integer
positionName	岗位名称	string
positionType	岗位类型	string
startTime	开始时间	string
userCode	员工code	string
userId	用户id	integer
endTime	结束时间	string(date-time)
eopId	岗位组织关联Id	integer(int64)
errorMessage	错误信息	string
faceUrl	人脸图片，查询的时候从user里面获取	string
faceUrlCreateTime	人脸图片上传时间，查询的时候从user里面获取	string(date-time)
faceUrlNotNull	人脸图片非空筛选，true 为非空，false为空	boolean
idCardNo	证件号码	string
idCardType	证件类型	string
idCardTypeName	证件类型名称	string
jobNumber	工号	string
keyword		string
lockStatus	锁定状态	boolean
masterPositionName	主岗位	string
name	名称	string
orgId	组织id	integer(int64)
orgIdList	组织id集合	array	integer
orgIds	员工所有部门ID	string
orgLink	组织链路	string
orgName	组织名称	string
organizations	组织集合	array	Organization对象
alias	别名	string
children	子集	array	Organization对象
code	组织编码	string
codeStep	编码步长	string
dataLevel	数据级别	string
description	描述	string
disabled	显示	boolean
employeeCount	员工数量	integer
enabled	是否启用	boolean
functionType	职能类型	string
functionTypeName	职能类型名称	string
latitude	纬度	string
leader	负责人	integer
leaderName	负责人名字	string
linkName	组织链路名称	string
logo	公司logo	string
longitude	经度	string
name	组织名称	string
offlineTime	离线时长	integer
orgId	组织id	integer
parentOrgId	父级组织ID	integer
qvId	企微部门ID	integer
qvParentId	企微父级部门ID	integer
type	组织类别（集团、公司、部门、区域..）	string
typeName	组织类型名称	string
useEnabled	使用树状态	boolean
userId	负责人对应的userid	integer
pageFindEmpOrgPositionFlag	分页查询的时候是否需要查询任职记录，默认不查询	boolean
password	密码	string
phone	手机号	string
positionCode	岗位code	string
positionId	岗位Id	integer(int64)
positionName	岗位名称	string
positionType	岗位类型	string
positionTypes		array	string
qvConfigId	企微新增联系方式的配置ID	string
qvQrCode	企微联系我二维码链接	string
qvUserId	企微USERID	string
remark	备注	string
resignedDate	离职时间	string(date-time)
roleCode	角色code	string
roleName	角色	string
sex	性别	string
sexName	性别名称	string
startDate	入职时间	string(date-time)
startTime	开始时间	string(date-time)
status	状态（true在职、false离职）	boolean
type	员工类型	string
typeName	员工类型描述	string
userId	用户ID	integer(int64)
message		string
successful		boolean

响应示例:

{
    "code": 0,
    "data": {
        "alias": "",
        "avatarUrl": "",
        "code": "",
        "companyId": 0,
        "companyName": "",
        "dataLevel": "",
        "deletedEmpOrgPositionIds": [],
        "deptName": "",
        "email": "",
        "empOrgPositionList": [
            {
                "avatarUrl": "",
                "companyId": 0,
                "companyName": "",
                "deptId": 0,
                "deptName": "",
                "employeeId": 0,
                "employeeName": "",
                "endTime": "",
                "masterFlag": false,
                "operateFlag": false,
                "orgCode": "",
                "orgCodeStep": "",
                "orgId": 0,
                "orgName": "",
                "orgType": "",
                "phone": "",
                "positionCode": "",
                "positionId": 0,
                "positionName": "",
                "positionType": "",
                "startTime": "",
                "userCode": "",
                "userId": 0
            }
        ],
        "endTime": "",
        "eopId": 0,
        "errorMessage": "",
        "faceUrl": "",
        "faceUrlCreateTime": "",
        "faceUrlNotNull": false,
        "idCardNo": "",
        "idCardType": "",
        "idCardTypeName": "",
        "jobNumber": "",
        "keyword": "",
        "lockStatus": false,
        "masterPositionName": "",
        "name": "",
        "orgId": 0,
        "orgIdList": [],
        "orgIds": "",
        "orgLink": "",
        "orgName": "",
        "organizations": [
            {
                "alias": "",
                "children": [
                    {
                        "alias": "",
                        "children": [
                            {}
                        ],
                        "code": "",
                        "codeStep": "",
                        "dataLevel": "",
                        "description": "",
                        "disabled": false,
                        "employeeCount": 0,
                        "enabled": false,
                        "functionType": "",
                        "functionTypeName": "",
                        "latitude": "",
                        "leader": 0,
                        "leaderName": "",
                        "linkName": "",
                        "logo": "",
                        "longitude": "",
                        "name": "",
                        "offlineTime": 0,
                        "orgId": 0,
                        "parentOrgId": 0,
                        "qvId": 0,
                        "qvParentId": 0,
                        "type": "",
                        "typeName": "",
                        "useEnabled": false,
                        "userId": 0
                    }
                ],
                "code": "",
                "codeStep": "",
                "dataLevel": "",
                "description": "",
                "disabled": false,
                "employeeCount": 0,
                "enabled": false,
                "functionType": "",
                "functionTypeName": "",
                "latitude": "",
                "leader": 0,
                "leaderName": "",
                "linkName": "",
                "logo": "",
                "longitude": "",
                "name": "",
                "offlineTime": 0,
                "orgId": 0,
                "parentOrgId": 0,
                "qvId": 0,
                "qvParentId": 0,
                "type": "",
                "typeName": "",
                "useEnabled": false,
                "userId": 0
            }
        ],
        "pageFindEmpOrgPositionFlag": false,
        "password": "",
        "phone": "",
        "positionCode": "",
        "positionId": 0,
        "positionName": "",
        "positionType": "",
        "positionTypes": [],
        "qvConfigId": "",
        "qvQrCode": "",
        "qvUserId": "",
        "remark": "",
        "resignedDate": "",
        "roleCode": "",
        "roleName": "",
        "sex": "",
        "sexName": "",
        "startDate": "",
        "startTime": "",
        "status": false,
        "type": "",
        "typeName": "",
        "userId": 0
    },
    "message": "",
    "successful": true
}

作者：admin 创建时间：2021-07-06 11:07
最后编辑：admin 更新时间：2025-05-30 16:03