入职信息采集登记表¶
获取企业的入职信息采集登记表模板列表¶
使用场景：该接口用于获取企业的入职信息采集登记表模版列表（即：2号人事部的入职登记模版），包括入职登记表名称、入职登记表说明。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/form_list/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": [
{
"form_id": "",
"form_name": "成美入职登记",
"form_desc": "成都美丽人生分公司的入职登记"
},
{
"form_id": "686460*****44f2987db8*****079b89",
"form_name": "深美入职登记",
"form_desc": "深圳美丽人生分公司的入职登记"
}
]
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| form_id | 入职登记表ID |
| form_name | 入职登记表名称 |
| form_desc | 入职登记表说明 |
获取企业的入职信息采集登记表详情¶
使用场景：该接口用于获取企业入职信息采集登记表的详细信息。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/all_field/?access_token=ACCESS_TOKEN&form_id=ID
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| form_id | String | 是 | 入职登记表模板ID |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"form_id": "fb90fe****1409885176****a1785f",
"form_name": "成美入职登记",
"form_desc": "成都美丽人生分公司的入职登记",
"field_group": [
{
"group_key": "person_base_info",
"group_title": "基本信息",
"items": [
{
"field_key": "emp_name",
"title": "姓名",
"field_value_type": "text"
}
]
},
{
"group_key": "education_info",
"group_title": "教育经历",
"items": [
{
"field_key": "enrollment_dt",
"title": "教育开始时间",
"field_value_type": "date"
}
]
},
{
"group_key": "attachment_data",
"group_title": "材料附件",
"items": [
{
"field_key": "ID_Card",
"title": "身份证原件照片",
"field_value_type": "file"
}
]
}
]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| form_id | 入职登记表模板ID |
| form_name | 职登记表模板名称 |
| form_desc | 入职登记表模板说明 |
| field_group | 入职登记表采集信息模块 |
| group_key | 入职登记表采集信息模块key |
| group_title | 入职登记表采集信息模块title |
| items | 入职登记表采集信息模块下包含的字段 |
| field_key | 入职登记表采集信息模块下的字段key |
| title | 入职登记表采集信息模块下的字段名称 |
| field_value_type | 入职登记表采集信息字段值的类型：text-文本类型,date-日期类型,file-文件类型 |
向入职人员推送入职信息采集登记表¶
使用场景：该接口用于向入职人员推送入职信息采集登记表，入职人员通过手机短信接收登记内容链接，跳转至2号人事部的入职登记小程序。
请求方式：POST（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/send/?access_token=ACCESS_TOKEN
请求包结构体为：
{
"entry_id": "流程ID",
"mobile": "待入职员工手机号",
"form_id": "入职登记表ID",
"user_name": "用户名称",
"hire_date": "入职时间",
"contact_company_id": "合同公司ID",
"sms_text": "自定义短信内容",
"form_data": {
"credentials_no": "440127xxxxxxxx1134",
"credentials_type": 1,
"allContact": {
"nodata": false,
"is_confirm": false,
"list": [
{
"contact_address": "广东省深圳市",
"contact_name": "路人甲",
"contact_relationship": "父子",
"contact_is_primary": true,
"contact_phone": "133xxxx0000"
}
]
}
}
}
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| entry_id | String | 是 | 流程ID |
| mobile | String | 是 | 待入职员工手机号 |
| form_id | String | 是 | 入职登记表ID |
| user_name | String | 是 | 用户名称 |
| hire_date | String | 是 | 入职时间 |
| contact_company_id | String | 是 | 合同公司ID |
| sms_text | String | 否 | 自定义短信内容 |
| form_data | Object | 否 | 入职登记表预填充内容 |
- 针对 sms_text 参数的使用说明：
所谓自定义短信内容，是指用户可以定义自己想要发送的短信文本信息，同时2号这边提供以下限定参数可以填充到内容中：
{user_name}- 用户名称{company_name}- 企业名称{link_url}- 链接地址(由2号这边生成)
使用示例如：
请求的参数sms_text传值：
sms_text = "尊敬的{user_name}, 感谢您加入{company_name}-央广购物+岗位外包，由于工作岗位的需要，需要您补充如下资料信息：外包岗位-信息采集，请点击链接完成资料提交{link_url}"
2号转换后生成的短信内容：
尊敬的张三, 感谢您加入 百度公司-岗位外包，由于工作岗位的需要，需要您补充如下资料信息：外包岗位-信息采集，请点击链接完成资料提交http: //www.2haohr.com
- 针对 form_data 参数的使用说明：
- form_data中的key，参考接口："获取企业的入职信息采集登记表详情"
- 在参考接口中的group_key属于("education_info", "work_experience", "allContact", "family", "training_experience", "skill")的，请按照示例"allContact"结构填写。其余group_key内的字段平铺于form_data中。
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"is_success": true
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| is_success | 操作是否成功：true or false |
获取入职人员的入职信息采集登记表详情¶
使用场景：该接口用于获取入职人员的入职信息采集登记表信息。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/info/?access_token=ACCESS_TOKEN&entry_id=ENTRY_ID
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| entry_id | String | 是 | 流程ID |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"form_data": {
"hire_date": "2020-05-22",
"age": 22,
"emp_name": "令狐冲",
"education_info": {
//教育经历
...
},
"person_base_info": {
//基本信息
...
},
"attachment_data": {
"ID_Card": [
"http://xxx.com/xxx.jpg",
"http://xxx.com/aa.png"
]
}
},
"entry_sign_status": 2
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| form_data | 表单数据 |
| entry_sign_status | 入职登记表状态 |
向入职人员重新推送入职信息采集登记表¶
使用场景：该接口用于重新发送入职人员入职登记表。
请求方式：POST（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/return_form/?access_token=ACCESS_TOKEN
请求示例：
{
"entry_id": "0ca89dc2****40aa****3a56ae6a4607",
"audit_list": [
{
"group_key": "education_info",
"audit_msg": "证件信息与证件材料内容不符"
},
{
"group_key": "person_base_info",
"audit_msg": "紧急联系人电话为空号"
}
]
}
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| entry_id | String | 是 | 流程ID |
| audit_list | Array | 是 | 审核信息列表 |
| group_key | String | 是 | 入职登记表采集信息模块key |
| audit_msg | String | 是 | 审核意见 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"is_success": true
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| is_success | 操作是否成功：true or false |
入职人员的入职信息采集登记表审核通过¶
使用场景：该接口用于提交审核通过入职人员提交的入职登记表。
请求方式：POST（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/audit_pass/?access_token=ACCESS_TOKEN
请求示例：
{
"form_data": {
"education_info": {
"nodata": false,
"list": [
{
"enrollment_dt": "2022-01",
"education": 1,
"graduation_dt": "2022-02",
"profession": "aaa"
}
],
"is_confirm": false
}
},
"entry_id": "0ca89dc2****40aa****3a56ae6a4607",
"group_key": "education_info"
}
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| entry_id | String | 是 | 流程ID |
| group_key | String | 是 | 入职登记表采集信息模块key |
| form_data | Object | 是 | 入职登记表采集信息模块数据 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"is_success": true
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| is_success | 操作是否成功：true or false |
获取入职人员的详细信息¶
使用场景：该接口用于获取入职人员的信息.
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/intent_employee/info/?access_token=ACCESS_TOKEN&entry_id=ENTRY_ID
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| entry_id | String | 是 | 流程ID |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"age": 20,
"contract_company_name": "xxx合同公司",
"credentials_no": "132****9800****023",
"credentials_type": 1,
"dep_name": "xxx研发部",
"email": "81*****671@163.com",
"emp_name": "zhangsan",
"emp_no": "100010",
"hire_date": "2018-01-01",
"id": "686460*****44f2987db8*****079b89",
"job_position_name": "职务名称",
"job_title_name": "岗位名称",
"mobile": "1588****610",
"probation": 0,
"recruit": "内部推荐",
"sex": 1,
"work_email": "81*****671@163.com",
"work_place_name": "工作地点名称",
"work_type": 1
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| age | 年龄 |
| contract_company_name | 合同公司名称 |
| credentials_no | 证件号码 |
| credentials_type | 证件类型(1:身份证 2:外国护照 5:台湾居民来往大陆通行证 6:港澳居民来往内地通行证 7:其他 8:香港身份证 9:台湾身份证 10:澳门身份证 11:外国人永久居留证) |
| dep_name | 部门名称 |
| 邮箱 | |
| emp_name | 员工姓名 |
| emp_no | 工号 |
| hire_date | 入职日期 |
| id | 待入职员工id |
| job_position_name | 职务名称 |
| job_title_name | 岗位名称 |
| mobile | 手机号码 |
| probation | 试用期(null:未设置,0:无试用期,1~12:表示N个月,15～90:表示N天) |
| recruit | 招聘渠道 |
| sex | 性别 (0:未填写;1:男;2:女) |
| work_email | 工作邮箱 |
| work_place_name | 工作地点名称 |
| work_type | 员工性质 (0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他;) |
入职人员的确认入职¶
使用场景：该接口用于将入职人员的确认入职
请求方式：POST（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/confirm_entry/?access_token=ACCESS_TOKEN
请求示例：
{
"entry_id": "0ca89dc2****40aa****3a56ae6a4607",
"hire_date": "2022-02-02"
}
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| entry_id | String | 是 | 流程ID |
| hire_date | String | 是 | 入职日期 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"is_success": true
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| is_success | 操作是否成功：true or false |
撤销入职人员的入职业务流程¶
使用场景：该接口用于撤销待入职员工的入职登记(工单作废的场景)
请求方式：POST（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/cancel/?access_token=ACCESS_TOKEN
请求示例：
{
"entry_id": "0ca89dc2****40aa****3a56ae6a4607"
}
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| entry_id | String | 是 | 流程ID |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"is_success": true
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| is_success | 操作是否成功：true or false |
创建待入职员工信息¶
使用场景：该接口用于创建待入职员工信息。
请求方式：POST（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/intention_employee_create/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| user_name | String | 是 | 用户姓名 |
| mobile | String | 是 | 手机号码 |
| contact_company_id | String | 是 | 合同公司id |
| hire_date | String | 是 | 入职日期 |
| credentials_type | Number | 否 | 证件类型(默认为1) 1:身份证 2:外国护照 5:台湾居民来往大陆通行证 6:港澳居民来往内地通行证 7:其他 8:香港身份证 9:台湾身份证 10:澳门身份证 11:外国人永久居留证 |
| credentials_no | String | 否 | 证件号码 |
| entry_id | String | 否 | 用户流程ID，如果需要关联用户流程，则此参数必填 |
| sex | Number | 否 | 性别 0:未知;1:男;2:女 |
| String | 否 | 个人邮箱 |
请求包结构体为：
{
"entry_id": "流程ID",
"mobile": "待入职员工手机号",
"user_name": "用户名称",
"hire_date": "入职日期",
"contact_company_id": "合同公司ID",
"credentials_type": 1,
"credentials_no": "证件号码"
}
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"is_success": true
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| is_success | 操作是否成功：true or false |
获取企业的入职信息采集登记表字段配置信息¶
使用场景：该接口用于获取获取企业的入职信息采集登记表字段配置信息。第三方可以通过该信息制作自定义的登记表表格。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/field_info/?access_token=ACCESS_TOKEN&form_id=ID
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| form_id | String | 是 | 入职登记表模板ID |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"form_id": "fb90fe****1409885176****a1785f",
"form_name": "成美入职登记",
"form_desc": "成都美丽人生分公司的入职登记",
"field_group": [
{
"group_key": "person_base_info",
"group_title": "基本信息",
"group_desc": "",
"sort": 1,
"multiple": false,
"items": [
{
"sort": 1,
"is_show": false,
"title": "姓名",
"field_key": "emp_name",
"print_flex": 2,
"placeholder": "请输入"
}
]
},
{
"sort": 2,
"multiple": true,
"group_desc": "请从最高学历填起",
"group_title": "教育经历"
"group_key": "education_info",
"items": [
{
"sort": 1,
"is_show": false,
"title": "",
"field_key": "id",
"print_flex": 2,
"placeholder": ""
}
]
}
]
}
]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| form_id | 入职登记表模板ID |
| form_name | 职登记表模板名称 |
| form_desc | 入职登记表模板说明 |
| field_group | 入职登记表采集信息模块 |
| group_key | 入职登记表采集信息模块key |
| group_title | 入职登记表采集信息模块title |
| group_desc | 入职登记表采集信息模块的描述 |
| sort | 入职登记表采集信息模块的排序 |
| multiple | 入职登记表采集信息模块是否有多行 |
| items | 入职登记表采集信息模块下包含的字段 |
| field_key | 入职登记表采集信息模块下的字段key |
| title | 入职登记表采集信息模块下的字段名称 |
| placeholder | 入职登记表采集信息模块下的字段的备注信息 |
| is_show | 入职登记表采集信息模块下的字段的备注信息是否展示 |
| sort | 入职登记表采集信息模块下的字段的排序 |
| print_flex | 入职登记表采集信息模块下的字段信息展示相对宽度 |
更新流程ID对应员工手机号¶
使用场景：更新流程ID对应员工手机号。
请求方式：POST（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/update_mobile/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| mobile | String | 是 | 手机号码 |
| entry_id | String | 是 | 用户流程ID |
特别说明： 存在员工身份且绑定员工端，更新手机号会对员工端身份进行解绑，当前使用的小程序可能会退出登陆。出现这种情况希望继续使用相应小程序，需要使用新手机号登陆，重新加入企业。
请求包结构体为：
{
"entry_id": "流程ID",
"mobile": "待入职员工手机号"
}
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"is_success": true
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| is_success | 操作是否成功：true or false |
获取流程对象详细信息¶
使用场景：获取流程对象详细信息。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employee/emp_entry_sign/get_entry_info/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| entry_id | String | 是 | 用户流程ID |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"intention_emp_id": "adbb870a39c84c91b1fxxxxxxx",
"employee_id": "9434648446e54e7e972xxxxxxx",
"mobile": "133xxxxx237",
"company_id": "fc5f0bebf8934355a9d7fxxxxxxx",
"entry_id": "bc450a73cd40409291fe39xxxxxxx",
"entry_sign_id": "5d6c89ab131d4a7f9eb4b0a9xxxxxxx",
"econtract_task_id": "46e54e7e974a7f9eb4b0a9xxxxxxx"
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| intention_emp_id | 待入职员工ID |
| employee_id | 员工ID |
| mobile | 手机号 |
| company_id | 企业ID |
| entry_id | 用户流程ID |
| entry_sign_id | 入职登记表记录ID |
| econtract_task_id | 电子合同任务记录ID |