员工部分信息批量同步接口
业务场景
该接口用于批量新增或更新员工。
接口限制
1. 10次/秒;
2. 单次导入限制为200条数据;
接口说明
1. 如果员工不存在则新增员工。如果员工存在,则只更新传入的参数,没传入的参数保持不变
2. 单条失败模式。即传入的每条数据互不影响。某条失败,不会影响其他数据执行。
3. 该接口工号作为唯一标识,如果客户工号变更,同步后会出现一条新记录
4. 同步时,不会校验英文大小写问题(即若更新的工号内容一致,仅大小写区别,系统将认为是同一个employeeId,并将系统内employeeId更新为最新导入的值)
接口地址
员工部分信息批量同步接口
/api/platform/employee/part/batch
请求类型
POST
请求参数
参数说明
参数名称 | 类型 | 是否必填 | 参数说明 |
---|---|---|---|
entCode | String(50) | 是 | 企业编号 |
operator | String(50) | 是 | 操作人编号 |
employees | List<EmployeeForm> | 是 | 员工请求信息 |
EmployeeForm额外说明
参数名称 | 类型 | 是否必填 | 参数说明 |
---|---|---|---|
employeeName | String(100) | 否 | 员工姓名,新增员工时必填。 修改员工时选填,不填时视为维持原数据。 |
String(100) | 否 | 工作邮箱,新增员工时工作邮箱和工作手机号至少填写一个。 修改员工时选填,不填时视为维持原数据。 传""视为清除原数据。 |
|
phoneNo | String(20) | 否 | 工作手机号,新增员工时工作邮箱和工作手机号至少填写一个。 修改员工时选填,不填时视为维持原数据。 传""视为清除原数据。 |
参数样例
{
"entCode" :"EC30GQQG0VB9JO",
"operator":"test",
"employees":[
{
"employeeId": "E10001",
"employeeName": "luo1",
"email": "luo1@maycur.com",
"phoneNo": "12345678901",
"employeeNickName": "花名",
"roleNames": [
"root"
],
"departments": [
{
"businessCode": "10001",
"defaultDepartment": true
}
],
"residences": [
{
"placeCode": "330101"
}
],
"customObject": {
"CF1395": 1,
"CF1396": {
"currencyCode": "CNY",
"amount": "1.00"
},
"CF1397": {
"currentTime": 1566204741186
}
}
}
]
}
响应参数
响应参数说明
参数名称 | 类型 | 是否必填 | 参数说明 |
---|---|---|---|
response_code | int | 是 | 响应码 |
response_message | String | 否 | 错误信息 |
data | String | 否 | 响应体 |
response_code - 响应码说明
参数样例
- 正常响应参数示例
{ "response_code": 0, "response_message": "", "data": null }
- 错误返回示例
{ "response_code": 9999, "response_message": "", "data": { "errorData": [ { "key": "E100011", "errorCode": "110005", "errorMessage": "当前员工常驻地设置只支持一个常驻地" } ] } }
errorData中的errorCode说明
错误码说明
修改记录
2023-04-25 新增