培训¶
获取培训计划详情¶
使用场景: 获取指定培训计划详情
请求方式: GET(HTTPS)
请求地址: https://openapi.2haohr.com/api/training/train_plan_detail/?access_token=ACCESS_TOKEN&train_plan_id=TRAIN_PLAN_ID
参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| train_plan_id | 是 | String | 培训计划Id |
| access_token | 是 | String | 调用接口凭证 |
返回结果:
{
"data": {
"desc": "培训计划备注",
"end_time": "2025-02-20 23:59:59",
"id": "4560794865633067008",
"plan_name": "开放平台自动化测试用例0217153321",
"start_time": "2025-02-12 00:00:00",
"status": 2,
"train_category_id": "3973174585701384192",
"train_category_name": "新员工入职培训",
"train_form_id": "3973174585701384203",
"train_form_name": "集中授课",
"train_introduce": "<p>培训计划介绍</p>"
},
"errorcode": 0,
"errormsg": ""
}
参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| plan_name | 是 | String | 培训计划名称 |
| id | 是 | String | 培训计划id |
| status | 是 | Number | 培训计划状态 1.未开课;2.开课中;3.已暂停;4.已完成 |
| train_category_name | 否 | String | 培训计划类型 |
| train_category_id | 否 | String | 培训计划类型id |
| train_form_name | 否 | String | 培训形式名 |
| train_form_id | 否 | String | 培训形式id |
| start_time | 是 | String | 计划开始时间 yyyy-MM-dd HH:mm:ss |
| end_time | 是 | String | 计划结束时间 yyyy-MM-dd HH:mm:ss |
| desc | 是 | String | 备注 |
| train_introduce | 否 | String | 培训介绍 |
获取培训计划的受训学员¶
使用场景: 获取指定培训计划包含员工信息
请求方式: POST(HTTPS)
请求地址: https://openapi.2haohr.com/api/training/train_member_list/?access_token=ACCESS_TOKEN
请求包结构体:
{
"train_plan_id": "3906311427597533184",
"batch_id": "6354875427597533184",
"p": 1,
"limit": 3
}
请求参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| p | 否 | Number | 开始页码,默认值1 |
| limit | 否 | Number | 每页条数,默认值10,最大值200 |
| train_plan_id | 是 | String | 培训计划Id |
| batch_id | 否 | String | 员工批次id,用于查询培训计划开始后添加的员工,如果不传则获取所有员工 |
| access_token | 是 | String | 调用接口凭证 |
接口说明:
培训计划id和员工批次id可通过监听培训计划相关事件获得。
返回结果:
{
"data": {
"end_time": "2025-02-20 23:59:59",
"id": "4560794865633067008",
"p": 1,
"plan_name": "开放平台自动化测试用例0217153321",
"start_time": "2025-02-12 00:00:00",
"status": 2,
"total_count": 7,
"totalpage": 3,
"user_info_list": [
{
"user_id": "0740efb3666d4634b8300a606c7e70fb",
"user_name": "毛晓"
},
{
"user_id": "179a8b197a96449085810a0ca373445b",
"user_name": "m2"
},
{
"user_id": "80e65ed2b77a4bc7939bef469acd5b5c",
"user_name": "小徐"
}
]
},
"errorcode": 0,
"errormsg": ""
}
响应参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| plan_name | 是 | String | 培训计划名称 |
| id | 是 | String | 培训计划id |
| status | 是 | Number | 培训计划状态 1.未开课;2.开课中;3.已暂停;4.已完成 |
| start_time | 是 | String | 计划开始时间 yyyy-MM-dd HH:mm:ss |
| end_time | 是 | String | 计划结束时间 yyyy-MM-dd HH:mm:ss |
| p | 是 | Number | 当前页码 |
| total_count | 是 | Number | 数据总条数 |
| totalpage | 是 | Number | 总页数 |
| user_info_list | 是 | Array | 包含人员列表 |
| └ user_id | 是 | String | 员工id |
| └ user_name | 是 | String | 员工名 |
获取学习计划详情¶
使用场景: 获取指定学习计划详情
请求方式: GET(HTTPS)
请求地址: https://openapi.2haohr.com/api/training/learning_plan_detail/?learning_plan_id=LEARNING_PLAN_ID&access_token=ACCESS_TOKEN
请求参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| learning_plan_id | 是 | String | 学习计划id |
| access_token | 是 | String | 调用接口凭证 |
接口说明:
学习计划id可通过监听学习计划相关事件获得。
返回结果:
{
"data": {
"desc": "测试开放平台学习计划",
"end_time": "2025-03-17 14:33:00",
"learning_plan_id": "4560795140510973952",
"plan_name": "开放平台自动化测试用例0217153337",
"plan_status": 1,
"start_time": "2025-02-17 15:33:00",
"train_category_id": "3973174585701384193",
"train_category_name": "制度文化培训",
"train_introduce": "<p>开放平台学习计划</p>"
},
"errorcode": 0,
"errormsg": ""
}
响应参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| plan_name | 是 | String | 学习计划名称 |
| learning_plan_id | 是 | String | 学习计划id |
| plan_status | 是 | Number | 计划状态 -1: 个人计划-无状态; 0: 未开始; 1: 进行中; 2: 已结束 |
| start_time | 是 | String | 开始时间 yyyy-MM-dd HH:mm:ss |
| end_time | 是 | String | 结束时间 yyyy-MM-dd HH:mm:ss |
| train_category_id | 否 | String | 计划类型id |
| train_category_name | 否 | String | 计划类型名 |
| desc | 否 | String | 描述 |
| train_introduce | 否 | String | 计划介绍,内容为富文本 |
获取学习计划的受训学员¶
使用场景:
获取指定学习计划包含员工信息。
请求方式:
POST(HTTPS)
接口地址:https://openapi.2haohr.com/api/training/learning_member_list/?access_token=ACCESS_TOKEN
请求包结构体:
{
"learning_plan_id": "4560795140510973952",
"batch_id": "654795140510973952",
"p": 1,
"limit": 3
}
参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| p | 否 | Number | 开始页码,默认值:1 |
| limit | 否 | Number | 每页条数,默认值:10,最大值200 |
| learning_plan_id | 是 | String | 学习计划id |
| batch_id | 是 | String | 员工批次id,用于查询学习计划开始后添加的员工,如果不传则获取所有员工 |
| access_token | 是 | String | 调用接口凭证 |
接口说明:
学习计划id和员工批次id可通过监听学习计划相关事件获得。
返回结果:
{
"data": {
"end_time": "2025-03-17 14:33:00",
"learning_plan_id": "4560795140510973952",
"p": 1,
"plan_name": "开放平台自动化测试用例0217153337",
"plan_status": 1,
"start_time": "2025-02-17 15:33:00",
"total_count": 4,
"totalpage": 2,
"user_info_list": [
{
"user_id": "0740efb3666d4634b8300a606c7e70fb",
"user_name": "毛晓"
},
{
"user_id": "25e2c3f5fd0449149df64349ae1c7a85",
"user_name": "天峰"
},
{
"user_id": "32f7bc2477bb472f8d1fb0247e8c6670",
"user_name": "小黄"
}
]
},
"errorcode": 0,
"errormsg": ""
}
响应参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| plan_name | 是 | String | 学习计划名称 |
| learning_plan_id | 是 | String | 学习计划id |
| plan_status | 是 | Number | 计划状态:-1(个人计划-无状态),0(未开始),1(进行中),2(已结束) |
| start_time | 是 | String | 开始时间,格式:yyyy-MM-dd HH:mm:ss |
| end_time | 是 | String | 结束时间,格式:yyyy-MM-dd HH:mm:ss |
| p | 是 | Number | 当前页码 |
| total_count | 是 | Number | 数据总条数 |
| totalpage | 是 | Number | 总页数 |
| user_info_list | 是 | Array | 包含人员列表 |
| └ user_id | 是 | String | 员工id |
| └ user_name | 是 | String | 员工姓名 |
获取考试信息详情¶
使用场景: 获取考试信息详情
请求方式: GET(HTTPS)
接口地址: https://openapi.2haohr.com/api/training/exam_record_detail/?exam_arrange_id=EXAM_ARRANGE_ID&access_token=ACCESS_TOKEN
请求参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| exam_arrange_id | 是 | String | 考试安排id |
| access_token | 是 | String | 调用接口凭证 |
接口说明:
考试安排id可通过监听考试相关事件获得。
返回结果:
{
"data": {
"end_time": "2025-02-22 00:00:00",
"exam_arrange_id": "4556036780603162624",
"exam_arrange_name": "测试考试安排003",
"makeup_exam": true,
"makeup_limit": -1,
"paper_id": "4510420121430966272",
"paper_name": "测试员工段考试结果显示",
"start_time": "2025-02-15 00:00:00"
},
"errorcode": 0,
"errormsg": ""
}
响应参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| exam_arrange_name | 是 | String | 考试名称 |
| exam_arrange_id | 是 | String | 考试id |
| paper_name | 是 | String | 试卷名称 |
| paper_id | 是 | String | 试卷id |
| start_time | 是 | String | 开始时间 yyyy-MM-dd HH:mm:ss |
| end_time | 是 | String | 结束时间 yyyy-MM-dd HH:mm:ss |
| makeup_exam | 是 | Boolean | 是否允许补考 |
| makeup_limit | 是 | Number | 补考次数,-1表示不限次数 |
获取考试人员信息¶
使用场景: 获取指定考试的考试人员信息
请求方式: POST(HTTPS)
接口地址: https://openapi.2haohr.com/api/training/exam_record_member_list/?access_token=ACCESS_TOKEN
请求包结构体:
{
"exam_arrange_id": "4556036780603162624",
"p": 1,
"limit": 3
}
请求参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| exam_arrange_id | 是 | String | 考试安排id |
| p | 否 | Number | 页码,默认值:1 |
| limit | 否 | Number | 每页数据数量,默认值:10,最大值200 |
| access_token | 是 | String | 调用接口凭证 |
接口说明:
考试安排id可通过监听考试相关事件获得。
返回结果:
{
"data": {
"exam_arrange_id": "4556036780603162624",
"exam_arrange_name": "测试考试安排003",
"p": 1,
"total_count": 5,
"totalpage": 2,
"user_info_list": [
{
"user_id": "25e2c3f5fd0449149df64349ae1c7a85",
"user_name": "天峰"
},
{
"user_id": "32f7bc2477bb472f8d1fb0247e8c6670",
"user_name": "小黄"
},
{
"user_id": "53443b11fbc8459e917bad903d358650",
"user_name": "林林"
}
]
},
"errorcode": 0,
"errormsg": ""
}
响应参数说明:
| 参数 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| exam_arrange_name | 是 | String | 考试名称 |
| exam_arrange_id | 是 | String | 考试安排id |
| p | 是 | Number | 当前页码 |
| total_count | 是 | Number | 数据总条数 |
| totalpage | 是 | Number | 总页数 |
| user_info_list | 是 | Array | 包含人员列表 |
| └ user_id | 是 | String | 员工id |
| └ user_name | 是 | String | 员工名 |