请求地址:
https://openapi.italent.cn/tenantbase/v1/{tenantId}/employee/timewindow/search 注:该接口是通过ModifiedTime所在查询时间范围返回的结果,因北森服务计算工龄司龄会造成员工数据的修改,如只获取业务修改时间,即在北森手动修改的数据,请用BusinessModifiedTime业务修改时间进行过滤
请求方式:POST
Content-Type: application/json
参数说明:
| 字段名称 | 类型 | 说明 |
|---|---|---|
| EmpStatus | Int数组 | 人员状态:1待入职;2试用;3正式;6退休;8离职;12非正式 |
| EmployType | Int数组 | 雇佣类型:0内部员工;1外部人员;2实习生 |
| ServiceType | Int数组 | 任职类型:0主职;1兼职;3返聘;4借调;5外派 |
| IsGetLatestRecord | Bool | 是否获取最新主职记录,默认是(为否时获取当前生效主职记录) |
| StartTime | DateTime | 时间范围开始时间,默认为调用接口当天的前一天00:00:00 |
| StopTime | DateTime | 时间范围结束时间,默认为调用接口当天的00:00:00 |
| WithDisabled | Bool | 是否包含停用/离职的记录,默认不包含 |
| WithDeleted | Bool | 是否包含删除的记录,默认不包含 |
| PageIndex | Int | 页码,默认为1 |
| PageSize | Int | 每页数量,最大为300 |
| Sort | Json | 排序:1正序,2倒序 |
| ExtParams | Json | 拓展参数,北森内部调用 |
| Columns | String数组 | 需要获取的员工信息和任职记录字段编码集合,必填 |
Columns:可用列查看**
自定义字段可以联系实施顾问或自己登录租配中心查看
员工信息
| 字段名称 | 字段编码 | 字段类型 | 允许输入 | 允许获取 | 字段描述 |
|---|---|---|---|---|---|
| 姓名 | Name | string | ✔️ | ✔️ | |
| 业务修改人 | BusinessModifiedBy | integer | ✔️ | ✔️ | 最后的业务修改人 |
| 业务修改时间 | BusinessModifiedTime | dateTime | ✔️ | ✔️ | 最后的业务修改时间 |
| 英文名 | EngName | string | ✔️ | ✔️ | |
| 电子邮件 | string | ✔️ | ✔️ | ||
| 个人邮箱 | BackupMail | string | ✔️ | ✔️ | |
| 证件号码 | IDNumber | string | ✔️ | ✔️ | |
| 护照号码 | PassportNumber | string | ✔️ | ✔️ | |
| 出生日期 | Birthday | dateTime | ✔️ | ✔️ | |
| 年龄 | Age | double | ✔️ | ✔️ | |
| 星座 | Constellation | integer | ✔️ | ✔️ | |
| 血型 | BloodType | integer | ✔️ | ✔️ | |
| 性别 | Gender | integer | ✔️ | ✔️ | |
| 民族 | Nation | string | ✔️ | ✔️ | |
| 工作照 | IDPhoto | string | ✔️ | ✔️ | |
| 政治面貌 | PoliticalStatus | string | ✔️ | ✔️ | |
| 婚姻状况 | MarryCategory | string | ✔️ | ✔️ | |
| 毕业学校 | LastSchool | string | ✔️ | ✔️ | |
| 专业 | Major | string | ✔️ | ✔️ | |
| 国籍 | Nationality | string | ✔️ | ✔️ | |
| 办公电话 | OfficeTel | string | ✔️ | ✔️ | |
| 户籍所在地 | Birthplace | string | ✔️ | ✔️ | |
| 籍贯 | RegistAddress | string | ✔️ | ✔️ | |
| 邮政编码 | PostalCode | string | ✔️ | ✔️ | |
| 联系地址 | HomeAddress | string | ✔️ | ✔️ | |
| 最高学历 | EducationLevel | string | ✔️ | ✔️ | |
| 毕业时间 | GraduateDate | dateTime | ✔️ | ✔️ | |
| 家庭电话 | HomePhone | string | ✔️ | ✔️ | |
| 办公地址 | BusinessAddress | string | ✔️ | ✔️ | |
| 手机号码 | MobilePhone | string | ✔️ | ✔️ | |
| 联系电话 | EmergencyContactPhone | string | ✔️ | ✔️ | |
| 紧急联系人 | EmergencyContact | string | ✔️ | ✔️ | |
| 与本人关系 | EmergencyContactRelationship | string | ✔️ | ✔️ | |
| 头像 | PictureUrl | string | ✔️ | ✔️ | |
| 微信 | WeiXin | string | ✔️ | ✔️ | |
| string | ✔️ | ✔️ | |||
| MSN | MSN | string | ✔️ | ✔️ | |
| 个人主页 | PersonalHomepage | string | ✔️ | ✔️ | |
| 特长 | Speciality | string | ✔️ | ✔️ | |
| Skype | Skype | string | ✔️ | ✔️ | |
| GTalk | GTalk | string | ✔️ | ✔️ | |
| 户口类别 | DomicileType | integer | ✔️ | ✔️ | |
| Blog链接地址 | Blog | string | ✔️ | ✔️ | |
| 电子邮件(工作) | WorkEmail | string | ✔️ | ✔️ | |
| 户籍地址 | ResidenceAddress | string | ✔️ | ✔️ | |
| 入党/团日期 | JoinPartyDate | dateTime | ✔️ | ✔️ | |
| 参加工作日期 | WorkDate | dateTime | ✔️ | ✔️ | |
| 区域 | Region | integer | ✔️ | ✔️ | |
| 备注 | AboutMe | string | ✔️ | ✔️ | |
| 用户标识 | UserMark | string | ✔️ | ✔️ | |
| MSN绑定的机器人帐号 | BindMsn | string | ✔️ | ✔️ | |
| 是否删除(废弃) | IsDeleted | boolean | ❌ | ✔️ | |
| 审批状态 | ApprovalStatus | string | ❌ | ✔️ | |
| 证件类型 | IDType | string | ❌ | ✔️ | |
| BeisenUserID | UserID | integer | ❌ | ✔️ | 北森用户ID |
| 创建人 | CreatedBy | integer | ❌ | ✔️ | 此字段为系统自动创建,请勿删除 |
| 创建时间 | CreatedTime | dateTime | ❌ | ✔️ | |
| 修改人 | ModifiedBy | integer | ❌ | ✔️ | |
| 修改时间 | ModifiedTime | dateTime | ❌ | ✔️ | |
| 删除状态 | StdIsDeleted | boolean | ❌ | ✔️ | 此字段为系统自动创建,请勿删除 |
| 简介 | Synopsis | string | ✔️ | ✔️ | 简介 |
| 参加工作日期(年) | WorkDateYear | long | ✔️ | ✔️ | |
| 参加工作日期(月) | WorkDateMonth | long | ✔️ | ✔️ | |
| 参加工作日期(日) | WorkDateDay | long | ✔️ | ✔️ | |
| LU_薪资档案(废弃) | LUSalaryProfile | string | ❌ | ✔️ | |
| 排序编码 | OrderCode | long | ❌ | ✔️ | |
| 邀请激活账号 | InviteForActivation | boolean | ✔️ | ✔️ | |
| 简历信息 | ResumeInformation | string | ✔️ | ✔️ |
任职记录
| 字段名称 | 字段编码 | 字段类型 | 允许输入 | 允许获取 | 字段描述 |
|---|---|---|---|---|---|
| 业务修改时间 | BusinessModifiedTime | dateTime | ✔️ | ✔️ | 最后的业务修改时间 |
| 人员 | UserID | integer | ❌ | ✔️ | |
| 业务修改人 | BusinessModifiedBy | integer | ✔️ | ✔️ | 最后的业务修改人 |
| 删除状态 | StdIsDeleted | boolean | ❌ | ✔️ | 此字段为系统自动创建,请勿删除 |
| 机构 | OIdOrganization | integer | ✔️ | ✔️ | |
| 部门 | OIdDepartment | integer | ✔️ | ✔️ | |
| 职位 | OIdJobPosition | string | ✔️ | ✔️ | |
| 职务 | OIdJobPost | string | ✔️ | ✔️ | |
| 职级 | OIdJobLevel | string | ✔️ | ✔️ | Lookup |
| 职等 | OidJobGrade | string | ✔️ | ✔️ | |
| 工作地点 | Place | string | ✔️ | ✔️ | |
| 入职日期 | EntryDate | dateTime | ✔️ | ✔️ | |
| 生效日期 | StartDate | dateTime | ✔️ | ✔️ | |
| 失效日期 | StopDate | dateTime | ✔️ | ✔️ | |
| 人员状态 | EmployeeStatus | string | ❌ | ✔️ | |
| 直线经理 | POIdEmpAdmin | integer | ✔️ | ✔️ | |
| 虚线经理 | POIdEmpReserve2 | integer | ✔️ | ✔️ | |
| 工号 | JobNumber | string | ✔️ | ✔️ | |
| 工龄校正值 | WorkYearBefore | float | ✔️ | ✔️ | |
| 司龄校正值 | WorkYearCompanyBefore | float | ✔️ | ✔️ | |
| 累计工龄 | WorkYearTotal | float | ✔️ | ✔️ | |
| 累计司龄 | WorkYearCompanyTotal | float | ✔️ | ✔️ | |
| 试用期开始日期 | ProbationStartDate | dateTime | ✔️ | ✔️ | |
| 试用期结束日期 | ProbationStopDate | dateTime | ✔️ | ✔️ | |
| 试用期实际结束日期 | ProbationActualStopDate | dateTime | ✔️ | ✔️ | |
| 试用期(月) | Probation | integer | ✔️ | ✔️ | |
| 转正日期 | RegularizationDate | dateTime | ✔️ | ✔️ | |
| 试用结果 | ProbationResult | string | ✔️ | ✔️ | |
| 顺序号 | Order | integer | ✔️ | ✔️ | |
| 人员类别 | EmploymentType | string | ✔️ | ✔️ | |
| 人员来源 | EmploymentSource | string | ✔️ | ✔️ | |
| 用工形式 | EmploymentForm | string | ✔️ | ✔️ | |
| 是否部门负责人 | IsCharge | string | ✔️ | ✔️ | |
| 身份类型 | IdentityLabel | string | ✔️ | ✔️ | |
| 业务类型 | BusinessTypeOID | string | ❌ | ✔️ | |
| 变动类型 | ChangeTypeOID | string | ✔️ | ✔️ | |
| 变动原因 | ChangeReason | string | ✔️ | ✔️ | |
| 变动说明 | ChangeDesc | string | ✔️ | ✔️ | 变动说明 |
| 变动后状态 | ChangedStatus | string | ❌ | ✔️ | |
| 异动类型 | TransitionTypeOID | string | ✔️ | ✔️ | |
| 审批状态 | ApprovalStatus | string | ❌ | ✔️ | |
| 雇佣关系 | EmployType | string | ✔️ | ✔️ | |
| 任职类型 | ServiceType | string | ❌ | ✔️ | |
| 任职状态 | ServiceStatus | string | ❌ | ✔️ | |
| 职务序列 | OIdJobSequence | string | ✔️ | ✔️ | |
| 专业条线 | OIdProfessionalLine | string | ✔️ | ✔️ | |
| 离职后去向 | Whereabouts | string | ✔️ | ✔️ | |
| 最后工作日 | LastWorkDate | dateTime | ✔️ | ✔️ | |
| OId | OId | string | ❌ | ✔️ | |
| 创建人 | CreatedBy | integer | ❌ | ✔️ | |
| 修改人 | ModifiedBy | integer | ❌ | ✔️ | |
| 创建时间 | CreatedTime | dateTime | ❌ | ✔️ | |
| 修改时间 | ModifiedTime | dateTime | ❌ | ✔️ | |
| 是否删除 | IsDeleted | boolean | ❌ | ✔️ | |
| 预留3 | POIdEmpReserve3 | integer | ✔️ | ✔️ | |
| 预留4 | POIdEmpReserve4 | integer | ✔️ | ✔️ | |
| 预留5 | POIdEmpReserve5 | integer | ✔️ | ✔️ | |
| 实习开始日期 | TraineeStartDate | dateTime | ✔️ | ✔️ | 实习开始日期 |
| 备注 | Remarks | string | ✔️ | ✔️ | |
| ExtendInfo | ExtendInfo | string | ✔️ | ✔️ | 携带拓展参数,内容由功能拓展决定 |
| 入职状态 | EntryStatus | string | ✔️ | ✔️ | |
| 入职日期(年) | EntryDateYear | long | ✔️ | ✔️ | |
| 入职日期(月) | EntryDateMonth | long | ✔️ | ✔️ | |
| 入职日期(日) | EntryDateDay | long | ✔️ | ✔️ | |
| 入职准备 | EntryPreparationStatus | string | ✔️ | ✔️ | 入职准备状态 |
| 直线经理交接 | POIdEmpAdminTransmitJunior | long | ✔️ | ✔️ | 原所有直线下级汇报关系转交给 |
| 虚线经理交接 | POIdEmpReserveTransmitJunior | long | ✔️ | ✔️ | 原所有虚线下级汇报关系转交给 |
| 默认入职日期入职 | DefaultEntryTimeStatus | boolean | ✔️ | ✔️ | |
| 排序编码 | OrderCode | long | ❌ | ✔️ | 用于添加排序编码,该编码是通过配置排序规则,并使用排序编码计算引擎计算出来的一组数值 |
| 排序编码1 | OrderCode1 | long | ❌ | ✔️ | 用于添加排序编码,该编码是通过配置排序规则,并使用排序编码计算引擎计算出来的一组数值 |
| LU_薪资档案 | LUSalaryProfile | string | ❌ | ✔️ | |
| LU_调薪管理 | LUSalaryAdjustment | string | ❌ | ✔️ | |
| LU_社保档案 | LUSocialSecurityProfile | string | ❌ | ✔️ | |
| 调动状态 | TransferStatus | string | ❌ | ✔️ | |
| LU_Offer | LUOffer | string | ❌ | ✔️ | |
| 是否有试用期 | IsHaveProbation | string | ❌ | ✔️ | 是否有试用期 |
| 同步到履历 | TransferSyncToJobHistory | boolean | ✔️ | ✔️ | 同步到履历(针对调动) |
| 发起电子文件签署废弃 | IsLanchElectronicSignature | boolean | ✔️ | ✔️ | |
| LU_任职变动记录 | LUEmpChangeRecord | string | ✔️ | ✔️ | 任职记录关联变动记录 |
| LU_签署记录 | LookUpSignRecord | string | ✔️ | ✔️ | |
| 发起电子文件签署 | ElectronicSignature | boolean | ✔️ | ✔️ | 开启前,请确保已经开通电子签产品。 |
| 加入黑名单 | AddOrNotBlackList | boolean | ✔️ | ✔️ | |
| 加黑原因 | BlackAddReason | string | ✔️ | ✔️ | |
| 加黑说明 | BlackStaffDesc | string | ✔️ | ✔️ | |
| 加黑原因 | BlackListAddReason | string | ✔️ | ✔️ |
示例地址:
https://openapi.italent.cn/tenantbase/v1/107934/employee/timewindow/search
**
请求示例:
{
“EmpStatus”: [
3
],
“EmployType”: [
0
],
“ServiceType”: [
0
],
“IsGetLatestRecord”: true,
“StartTime”: “2019-03-21T07:05:30.937Z”,
“StopTime”: “2019-03-23T07:05:30.937Z”,
“WithDisabled”: true,
“WithDeleted”: true,
“PageIndex”: 1,
“PageSize”: 300,
“Sort”: {“UserID”:1},
“ExtParams”: {},
“Columns”: [
“Name”,”JobNumber”
]
}
返回示例:
{
“Total”: 3,
“Data”: [
{
“BasicInfos”: {
“Sys_Id”: “d9982382-9c83-46e8-bf0d-1e865fb4cb33”,
“Name”: “测试邮箱2”,
“StdIsDeleted”: false,
“UserID”: 118060112
},
“ServiceInfos”: [
{
“Sys_Id”: “13dbe037-e84e-4db5-9652-7c1fea4286dd”,
“JobNumber”: “”,
“PObjectDataID”: “d9982382-9c83-46e8-bf0d-1e865fb4cb33”,
“StdIsDeleted”: false,
“UserID”: 118060112
}
]
},
{
“BasicInfos”: {
“Sys_Id”: “abb67607-52d2-43f6-90d9-80982c7a3889”,
“Name”: “新增测试员工4”,
“StdIsDeleted”: false,
“UserID”: 118060117
},
“ServiceInfos”: [
{
“Sys_Id”: “12e2429d-d72e-45f2-9911-40592500cccf”,
“JobNumber”: “”,
“PObjectDataID”: “abb67607-52d2-43f6-90d9-80982c7a3889”,
“StdIsDeleted”: false,
“UserID”: 118060117
}
]
},
{
“BasicInfos”: {
“Sys_Id”: “f29bbf09-057d-4769-8982-bca70c56278b”,
“Name”: “测试邮箱”,
“StdIsDeleted”: false,
“UserID”: 118060125
},
“ServiceInfos”: [
{
“Sys_Id”: “454878a7-ccff-4872-be7b-a4201b3fcf28”,
“JobNumber”: “”,
“PObjectDataID”: “f29bbf09-057d-4769-8982-bca70c56278b”,
“StdIsDeleted”: false,
“UserID”: 118060125
}
]
}
],
“Code”: 200,
“Message”: null,
“Extra”: null
}
| 字段名称 | 类型 | 说明 |
|---|---|---|
| Total | int | 总数 |
| Data | 数组 | 员工数据 |
| BasicInfos | json | 员工信息 |
| ServiceInfos | json | 任职记录 |
| Code | int | 状态码 |
| Message | string | 返回的提示信息 |
| Extra |
