新增/更新
- 接口:/employee/save
- Method:POST
- 数据格式:JSON
- 接口说明:每批最多处理300个数据
请求参数
参数 | 类型 | 必须 | 默认值 | 主键 | 描述 |
---|---|---|---|---|---|
mobile | string | Y | 手机号码(也可提供邮箱) | ||
string | Y | 邮箱(也可提供手机号码) | |||
name | string | Y | 员工姓名 | ||
employeeId | string | Y | Y | 员工工号 | |
rank | string | 员工职级名称, (如果系统无该职级,将自动创建该职级) | |||
position | string | 员工职务编码 | |||
departments | array | Y | 员工所属部门,及部门上级,详见下表 | ||
status | string | ENABLE | 员工在职状态, 可以选择ENABLE, DISABLE | ||
defaultSubsidiaryBizCode | string | 员工默认业务实体 | |||
defaultDepartmentBizCode | string | 员工默认部门 | |||
hireDate | long | 入职时间,填时间戳,精确到毫秒,例如:1569569158000 | |||
tag | string | 属性,可被用于流程 | |||
source | string | 外联平台,可选值 WEIXIN、DING_TALK | |||
sourceId | string | 外联平台key 格式:外联平台的企业ID+"_"+外联平台的用户ID | |||
residenceCode | string | 常驻地,传入每刻地址编码,具体见备注 | |||
custField1 | string | 自定义字段1 | |||
custField2 | string | 自定义字段2 | |||
custField3 | string | 自定义字段3 | |||
custField4 | string | 自定义字段4 | |||
custField5 | string | 自定义字段5 | |||
custField6 | string | 自定义字段6 | |||
custField7 | string | 自定义字段7 | |||
custField8 | string | 自定义字段8 | |||
custField9 | string | 自定义字段9 | |||
custField10 | string | 自定义字段10 | |||
note | string | 备注 | |||
nickName | string | 员工昵称,用于同步生态平台 | |||
firstName | string | 名 | |||
middleName | string | 多为非中国人填写使用 | |||
lastName | string | 姓 | |||
restrictSubsidiaryBizCodes | array | 限定的业务实体 | |||
notifyActivation | boolean | false | 是否发送加入通知 | ||
identityCardNo | string | 身份证号码 |
部门列表
参数 | 类型 | 必须 | 默认值 | 主键 | 描述 |
---|---|---|---|---|---|
departmentBizCode | string | Y | 部门编码 | ||
managerId | string | N | 上级工号 | ||
cover | string | N | Y | 是否承担部门, 如果不是承担部门,请输入 N | |
positionBizCode | string | N | 职务编码 |
返回数据
字段 | 类型 | 描述 |
---|---|---|
code | string | 系统内唯一主键 |
employeeId | string | 员工工号 |
备注
- 部门内上级必须在当前员工之前被提交;
- 每刻提供每刻的地址编码,接口调用方需要把地址映射成每刻的地址编码。比如常驻地为临安,需要传入每刻地址编码domestic-ZH32-ZH32_1-ZH32_1_85,如常驻地为墨西哥,需要传入abroad-MEX
- 如果要使用自定义字段custField1 - custField10, 请和我们联系,开启相关功能;
- note 字段用于定义显示在员工-个人设置页面, 用于提醒员工的信息,可以应用自定义字段;如果custField1,配制显示为 成本中心;note 设置为: 成本中心{成本中心}; 某员工的成本中心为A001; 那么在该员工的个人设置页面提醒显示为: 成本中心A001
- 职务全路径为见每刻企业设置-职务,点击对应的职务详情里的职务路径的值,例如一级职务/二级职务
- source、sourceId必须成对出现
- 该接口采用单条失败的处理方式,即整批数据中,如果只有其中的几条因为各种原因失败,那么只有那几条数据不会被保存;其它的数据仍然会被正常处理;错误数据的主键(employeeId)会被放在errorData里面;errorData为结构体, 包含出错记录主键(employeeId), 以及与之对应的出错信息; 类似 {"employeeId": "错误信息"}; 具体参见失败示例;如果有错误信息,则返回的code为NACK,然后错误信息会放在errorData里,只有全部成功返回的code为ACK。
示例
请求数据
{
"timestamp": 123456,
"data": [
{
"mobile": "12345667",
"email": "a@b.com",
"name": "测试A",
"employeeId": "001",
"rank": "P1",
"position": "EMPLOYEE",
"status": "ENABLE",
"departments": [
{
"departmentBizCode": "YFA",
"managerId": "000"
}
],
"restrictSubsidiaryBizCodes": ["AB3D"]
}
]
}
返回数据(成功)
{
"code": "ACK",
"message": "",
"data": [
{
"code": "ABCDAAFA1234",
"employeeId": "001"
}
]
}
返回数据(失败)
{
"code": "NACK",
"message": null,
"errorData":{"001":"缺少部门信息"}
...
}