员工请求体 EmployeeForm
说明
EmployeeForm
请求参数
参数说明
字段名称 | 字段类型 | 是否必填 | 字段说明 |
---|---|---|---|
employeeId | String(50) | 是 | 员工工号 |
employeeName | String(50) | 是 | 员工姓名。 新增员工时必填。 修改员工时选填,不填时视为维持原数据。 |
String(50) | 否 | 工作邮箱, 新增员工时工作邮箱和工作手机号至少填写一个。 修改员工时选填,不填时视为维持原数据。 选填,传""视为清除原数据。 |
|
phoneNo | String(50) | 否 | 工作手机号, 新增员工时工作邮箱和工作手机号至少填写一个。 修改员工时选填,不填时视为维持原数据。 选填,传""视为清除原数据。 |
employeeNickName | String(50) | 否 | 员工花名, 不填时视为维持原数据 填写空字符串时视为清除原数据 |
roleNames | List<String> | 否 | 员工角色名称,具体见设置页面‘角色与权限-角色名称’, 不填时视为维持原数据 填写空数组时视为清除原数据 |
departments | List<RTRoute> | 是 | 所属部门, 修改员工时不填视为维持原数据。 以上传的部门信息作为员工的最终所属部门信息(不传的部门会被删除) |
residences | List<PlaceInfo> | 否 | 常驻地, 不填时视为维持原数据 填写空数组时视为清除原数据 |
customObject | CustomObject | 否 | 员工的自定义字段, 不填时视为维持原数据 填写空对象时视为清除原数据 |
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
}
}
}
修改记录
2023-04-11 新增