获取员工基础列表
接口说明: 查询员工基础信息的列表,主要包含员工的id,姓名,手机号,入职日期,聘用形式以及员工状态等基本信息。
请求方式:POST(HTTPS)
请求地址:https://api.xinrenxinshi.com/v5/employee/simplelist
请求Header:
key | value |
---|---|
access_token | 获取的access_token的实际值 |
Query参数:
key | value |
---|---|
sign | 签名值 |
Body参数:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
pageNo | Integer | Y | 起始页码,默认从0开始,翻页+1 |
pageSize | Integer | Y | 查询员工数量,单次数量限制100 |
fetchChild | Integer | Y | 是否包含子部门员工,0不包含,1包含 |
departmentId | String | N | 部门ID,不传表示全部部门员工 |
status | Integer | N | 员工状态,默认为0。0:在职员工、1:离职员工、2:待入职、8:删除 |
modtime | Integer | N | 更新时间(精确到秒),员工基础列表的增量查询。如果传了该参数,则只返回更新时间在查询时间之后的员工数据 |
timestamp | Long | Y | 请求时间戳(精确到毫秒) |
返回结果:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
errcode | Integer | Y | 错误码 |
errmsg | String | Y | 错误信息 |
data | PageResult | Y | 响应数据 |
PageResult
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
totalPageSize | Long | Y | 总页数 |
hasMore | boolean | Y | 是否有下一页 true-有,false-没有 |
pageNo | Integer | Y | 当前页 |
pageSize | Integer | Y | 每页显示条数 |
result | List<EmployeeSimple> | Y | 员工基础信息列表 |
EmployeeSimple
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
employeeId | String | Y | 员工ID |
entryDate | String | Y | 入职时间,格式:yyyy-MM-dd |
hireType | Integer | Y | 聘用类型,0-正式,10-实习,11-劳务,12-顾问,13-返聘,14-外包,15-兼职 |
mobile | String | Y | 手机号 |
String | Y | 工作邮箱 | |
name | String | Y | 员工名字 |
status | Integer | Y | 员工状态,0:在职员工、1:离职员工、2:待入职、8:删除 |
addtime | Integer | Y | 添加时间 |
modtime | Integer | Y | 更新时间 |
请求示例(HTTPS):
https://api.xinrenxinshi.com/v5/employee/simplelist?sign=X5O4br3gDtG1wMwSnWCkWe%2BXIgQ%3D
请求Body示例:
{
"pageNo": 0,
"pageSize": 10,
"fetchChild": 1,
"status": 0,
"timestamp": 1606198702442
}
SDK请求示例(java):
EmployeeBasicInfoListRequest request = new EmployeeBasicInfoListRequest(access_token);
request.setDepartmentId(null);
request.setFetchChild(FetchChildEnum.CONTAINS_DEPARTMENT);
request.setPageNo(0);
request.setPageSize(10);
request.setStatus(EmpStatusEnum.ON_JOB);
OpenapiResponse<PageResult<EmployeeSimple>> list = XrxsEmployeeService.getSimpleEmployeeList(request);
响应示例:
{
"errcode": 0,
"errmsg": "成功",
"data": {
"totalPageSize": 1,
"pageNo": 0,
"pageSize": 10,
"hasMore": false,
"result": [
{
"employeeId": "1b31e851525c4bf6a7261e166a0fafa8",
"name": "张六",
"mobile": "19400235259",
"email": "a@qq.com",
"entryDate": "2022-11-24",
"hireType": 0,
"status": 0,
"addtime":1606100590,
"modtime":1606308521
},
{
"employeeId": "04577f3277f841248f17d36e2561f642",
"name": "方旭",
"mobile": "19002393231",
"email": "b@qq.com",
"entryDate": "2019-11-12",
"hireType": 0,
"status": 0,
"addtime":1608013535,
"modtime":1608013535
},
{
"employeeId": "3cfd59661b0642659f12eb8c75ad0f18",
"name": "张四",
"mobile": "19400232259",
"email": "c@qq.com",
"entryDate": "2022-11-24",
"hireType": 0,
"status": 0,
"addtime":1602751809,
"modtime":1606100673
},
{
"employeeId": "d0a222320a8346e9a9aba14f890cc18c",
"name": "张七",
"mobile": "19400235449",
"email": "d@qq.com",
"entryDate": "2020-11-23",
"hireType": 0,
"status": 0,
"addtime":1606103550,
"modtime":1606308231
}
]
}
}