员工部分信息批量同步接口
业务场景
该接口用于批量新增或更新员工。
接口限制
- 10次/秒;
- 单次导入限制为200条数据;
接口说明
- 单条失败模式。即传入的每条数据互不影响。某条失败，不会影响其他数据执行。
- 该接口工号作为唯一标识，如果入参工号不存在，同步后会出现一条新记录
- 同步时，不会校验英文大小写问题（即若更新的工号内容一致，仅大小写区别，系统将认为是同一个employeeId，并将系统内employeeId更新为最新导入的值）
- 除employeeId必填外，其他字段均非必填，若不填写视为维持原数据
接口地址
/api/openapi/employee/part/batch
请求类型
POST
请求参数
参数说明
| 字段名称 | 字段类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| employeeId | String(50) | 是 | 员工工号 |
| employeeName | String(50) | 否 | 员工姓名。 新增员工时必填。 修改员工时选填，不填时视为维持原数据。 |
| String(50) | 否 | 工作邮箱， 新增员工时工作邮箱和工作手机号至少填写一个。 修改员工时选填，不填时视为维持原数据。 选填，传""视为清除原数据。 |
|
| phoneNo | String(50) | 否 | 工作手机号， 新增员工时工作邮箱和工作手机号至少填写一个。 修改员工时选填，不填时视为维持原数据。 选填，传""视为清除原数据。 请按照“+国际区号”“手机号”格式写入，如+8615700115928，以确保写入的数据正确。 |
| employeeNickName | String(50) | 否 | 员工花名， 不填时视为维持原数据 填写空字符串时视为清除原数据 |
| roleNames | List<String> | 否 | 员工角色名称，具体见设置页面‘角色与权限-角色名称’， 不填时视为维持原数据 填写空数组时视为清除原数据 |
| departments | List<RTRoute> | 否 | 所属部门， 修改员工时不填视为维持原数据。 以上传的部门信息作为员工的最终所属部门信息（不传的部门会被删除） |
| residences | List<PlaceInfo> | 否 | 常驻地， 不填时视为维持原数据 填写空数组时视为清除原数据 |
| customObject | CustomObject | 否 | 员工的自定义字段， 不填时视为维持原数据 填写空对象时视为清除原数据 |
| updateCustomObject | boolean | 否 | 是否对传入的和已经存在的CustomObject进行比对, 否:不比对, 是:比对,更新比对匹配的, 没匹配的保留. 默认false |
| sendInvitation | boolean | 否 | 是否发送邀请通知（邮件或短信）。默认false。true情况下只有员工状态不属于已加入情况下才会发送且只会发送一次。（ 如离职后，再入职，则需手动再在系统内发送邀请通知）。 链接有效期为15天。 |
| status | String(16) | 否 | 在职状态，可填写ENABLE（在职），DISABLE（离职） 不填时视为维持原数据，当新增员工时不填写默认为ENABLE |
| hireDate | String (50) | 否 | 入职日期。格式yyyy-MM-dd。 不填时视为维持原数据 填写空字符串时视为清除原数据 |
| defaultLegalEntityBizCode | String (50) | 否 | 默认公司编码， 不填时视为维持原数据 填写空字符串时视为清除原数据 |
| classPositionBizCode | String(50) | 否 | 职级编码， 不填时视为维持原数据 填写空字符串时视为清除原数据 |
| idInfo | List<IdInfo> | 否 | 证件信息， 不填时视为维持原数据 填写空数组时视为清除原数据 |
| enName | EnName | 否 | 英文名， 不填时视为维持原数据 |
| gender | String(10) | 否 | 性别，可填写MAN（男），WOMAN（女）， 不填时视为维持原数据 填写空字符串时视为清除原数据 |
| allowEmailAndPhoneBeNull | boolean | 否 | 允许邮箱或手机号为空， 默认false。true情况下不校验邮箱或手机号的必填性。 |
RTRoute参数说明：
| 字段名 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| businessCode | String | 是 | 部门编码 |
| positionBizCode | String | 否 | 职位编码， 不填时视为维持原数据 填写空字符串时视为清除原数据 |
| supervisorEmployeeId | String | 否 | 直接上级工号， 不填时视为维持原数据 填写空字符串时视为清除原数据 |
| defaultDepartment | boolean | 否 | 默认部门(不填默认是false) |
PlaceInfo参数说明：
| 字段名 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| placeCode | String | 是 | 地址代码，如“330101”，见每刻地址库 |
IdInfo参数说明：
| 字段名 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| idType | String | 是 | 证件类型，可选值 ID_CARD(身份证), GATResidencePermit(港澳台居民居住证), WGRResidenceIdCard(外国人永久居留身份证), GATMainlandPass(港澳居民来往内地通行证), TAIWAN_TravellingPass(台湾居民来往大陆通行证), Protection(护照) |
| idNumber | String | 是 | 证件号码 |
EnName参数说明：
| 字段名 | 类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| firstName |
String | 是 | First Name |
| middleName | String | 否 | Middle Name |
| lastName | String | 否 | Last Name |
参数样例
[
{
"employeeId": "E10001",
"employeeName": "luo1",
"email": "luo1@maycur.com",
"phoneNo": "12345678901",
"employeeNickName": "花名",
"roleNames": [
"luo@maycur.com"
],
"departments": [
{
"businessCode": "10001",
"defaultDepartment": true
}
],
"residences": [
{
"placeCode": "330101"
}
],
"customObject": {
"CF1395": 1,
"CF1396": {
"currencyCode": "CNY",
"amount": "1.00"
},
"CF1397": {
"currentTime": 1566204741186
}
}
}
]
响应参数
参数样例
- 正常响应参数示例
{
"success": true,
"code": "ACK",
"message": "保存成功！",
"data": null
}
- 错误返回示例
{
"success": false,
"code": "NACK",
"message": "",
"data": {
"errorData": [
{
"key": "E10001",
"errorCode": "110001",
"errorMessage": "找不到对应的员工"
}
]
}
}
errorData中的errorCode说明
修改记录
2023-04-25 新增