服务端API



获取线下培训分类列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/training/category/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "uuid"  : "分类唯一ID1",
                "title" : "分类标题1",
                "parent_id": "1C09EBF2-A8D9-4BDF-8D60-FADE743E1501",
                "create_time": 1546565453000,
            },
          	{
                "uuid"  : "分类唯一ID2",
                "title" : "分类标题2",
                "parent_id": "2C09EBF2-A8D9-4BDF-8D60-FADE743E1502",
                "create_time": 1546565453000,
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的分类列表
uuid String 分类唯一ID,最大长度36字符
title String 分类标题,最大长度64字符
parent_id String 分类父ID,最大长度36字符
create_time String 创建时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取线下培训列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/training/training/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
start_time Int 是 线下培训创建时间的查询起始时间,Unix时间戳,单位毫秒
end_time Int 是 线下培训创建时间的查询结束时间,Unix时间戳,单位毫秒
注意:起始与结束时间差不超365天
status Int 否 线下培训状态:
0 未发布
1 已发布
2 已关闭
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "uuid": "线下培训唯一ID",
                "title": "线下培训标题",
                "category_id": "1C09EBF2-A8D9-4BDF-8D60-FADE743E1508",
                "status" : 1,
                "certificate_id": "100619E7-5004-464D-A80A-D9D2DFA4F271",
                "description": '线下培训简介',
                "lector_id": "D1C71591-DCAA-4751-B2C3-B1CC31E95A8E",
                "enroll_num": 10,
                "train_start_time": 1546565453000,
                "train_end_time": 1609957197000,
                "enroll_start_time": 1546565453000,
                "enroll_end_time": 1609957197000,
                "training_num": 1
            },
          	{
                "uuid": "线下培训唯一ID",
                "title": "线下培训标题",
                "category_id": "1C09EBF2-A8D9-4BDF-8D60-FADE743E1508",
                "status" : 1,
                "certificate_id": "100619E7-5004-464D-A80A-D9D2DFA4F271",
                "description": '线下培训简介',
                "lector_id": "363FED3E-D1CC-4FE5-A9CD-65A0C44889CE",
                "enroll_num": 10,
                "train_start_time": 1546565453000,
                "train_end_time": 1609957197000,
                "enroll_start_time": 1546565453000,
                "enroll_end_time": 1609957197000,
                "training_num": 1
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
uuid String 线下培训唯一ID,最大长度36字符
title String 线下培训标题,最大长度225字符
category_id String 线下培训分类ID,最大长度36字符
status Int 线下培训状态:
0 未发布
1 已发布
2 已关闭
certificate_id String 关联证书ID,最大长度36字符
description String 线下培训简介,最大长度65535字符
lector_id String 关联讲师ID,最大长度36字符
enroll_num Int 报名人数,最大位数11
train_start_time Int 培训开始时间,Unix时间戳,单位毫秒
train_end_time Int 培训结束时间,Unix时间戳,单位毫秒
enroll_start_time Int 报名开始时间,Unix时间戳,单位毫秒
enroll_end_time Int 报名结束时间,Unix时间戳,单位毫秒
training_num Int 培训人数,最大位数11
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取线下培训报名学员列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/training/user/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
training_id String 是 线下培训ID
start_time Int 否 线下培训指派时间的查询起始时间,Unix时间戳,单位毫秒
注意:开始时间与当前时间差不能大于365天
end_time Int 否 线下培训指派时间的查询结束时间,Unix时间戳,单位毫秒
注意:起始与结束时间差不超7天
userid_list String 否 员工在企业内的UserID列表,多个UserId用英文逗号隔开,一次最多100个
page Int 是 页码,从1开始
page_size Int 是 每页条数,最大100

Query参数提示: userid_list参数与start_time、end_time时间参数二选一,不能同时不传。

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [ 
            {
                "dept_user_id": "11121033-3F87-48E3-B1B7-EBEF3339B8C1",
                "training_status": "fail",
                "enroll_status": "learning",
                "enroll_time": 1659957197000,
                "survey_status": "not_attempt",
                "survey_time": 1659957197000,
                "sign_status": 1659957197000,
                "sign_time": 1659957197000,
                "sign_up_num": 0,
                "sign_back_num": 0,
                "evaluate_status": "not_evaluate",
                "evaluate_time": 1546565453000,
                "exam_id": "E1121033-3F87-48E3-B1B7-EBEF3339B8C1",
                "point": 0,
                "credit": 0,
                "completed_time": 1669957197000
            },
          	{
                "dept_user_id": "21121033-3F87-48E3-B1B7-EBEF3339B8C2",  
                "training_status": "fail",
                "enroll_status": "learning",
                "enroll_time": 1659957197000,
                "survey_status": "not_attempt",
                "survey_time": 1659957197000,
                "sign_status": 1659957197000,
                "sign_time": 1659957197000,
                "sign_up_num": 0,
                "sign_back_num": 0,
                "evaluate_status": "not_evaluate",
                "evaluate_time": 1546565453000,
                "exam_id": "E1121033-3F87-48E3-B1B7-EBEF3339B8C1",
                "point": 0,
                "credit": 0,
                "completed_time": 1669957197000
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
dept_user_id String 用户ID,最长64位字符
training_status String 培训状态:
audit 待审核
cancelled 取消报名
completed 培训完成
enroll 报名成功
evaluate 已评估
refuse 拒绝
signUp 已签到
stay 待报名
enroll_status String 用户报名状态:
stay 待报名
enroll 已报名
enroll_time Int 报名时间,Unix时间戳,单位毫秒,未报名为0
survey_status String 调查评估参与状态:
not_attempt 未参与
finished 已参与
survey_time Int 调查评估参与时间,Unix时间戳,单位毫秒,未参与为0
sign_status String 签到状态:
cancelled 取消签到
not_sign 未签到
signUp 已签到
sign_time Int 最后签到时间,Unix时间戳,单位毫秒,未签到为0
evaluate_status String 评估状态:
evaluate 已评估
not_evaluate 未评估
evaluate_time Int 评估时间
exam_id String 关联考试ID
point Float 获得积分
credit Flost 获得学分
completed_time 完成培训时间,Unix时间戳,单位毫秒,未完成为0
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取线下培训报名学员信息

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/training/user/info
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
training_id String 是 线下培训ID
dept_user_id String 是 员工在企业内的UserID

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "target_id" : "F52FAEAB-5C9F-4A4B-A183-6E04835063A8",
        "target_title" : "线下培训名称",
        "category_id" : "95DD4D72-E504-4550-81A2-F48EFEEB8FC2",
        "category_title" : "通用培训", 
        "dept_user_id": "11121033-3F87-48E3-B1B7-EBEF3339B8C1",
        "training_status": "fail",
        "enroll_status": "learning",
        "enroll_time": 1659957197000,
        "survey_status": "not_attempt",
        "survey_time": 1659957197000,
        "sign_status": 1659957197000,
        "sign_time": 1659957197000,
        "sign_up_num": 0,
        "sign_back_num": 0,
        "evaluate_status": "not_evaluate",
        "evaluate_time": 1546565453000,
        "exam_id": "E1121033-3F87-48E3-B1B7-EBEF3339B8C1",
        "point" : 12.25,
        "credit": 8.10,
        "completed_time": 1669957197000
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
dept_user_id String 用户ID,最长64位字符
training_status String 培训状态:
- audit 待审核
- cancelled 取消报名
- completed 培训完成
- enroll 报名成功
- evaluate 已评估
- refuse 拒绝
- signUp 已签到
- stay 待报名
enroll_status String 用户报名状态:
- stay 待报名
- enroll 已报名
enroll_time Int 报名时间,Unix时间戳,单位毫秒,未报名为0
survey_status String 调查评估参与状态:
- not_attempt 未参与
- finished 已参与
survey_time Int 调查评估参与时间,Unix时间戳,单位毫秒,未参与为0
sign_status String 签到状态:
- cancelled 取消签到
- not_sign 未签到
- signUp 已签到
sign_time Int 最后签到时间,Unix时间戳,单位毫秒,未签到为0
sign_up_num Int 签到数量
sign_back_num Int 签退数量
evaluate_status String 评估状态:
- evaluate 已评估
- not_evaluate 未评估
evaluate_time Int 评估时间
exam_id String 关联考试ID
point Decimal(12,2) 获得积分
credit Decimal(12,2) 获得学分
completed_time 完成培训时间,Unix时间戳,单位毫秒,未完成为0



创建线下培训

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/training/training/create
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_user_id String 是 创建者UID
train_id String 否 线下培训ID,10-36位字符串,不传则系统自动生成
title String 是 线下培训名称,最大长度225字符
category_id String 是 线下培训分类ID
start_time Int 是 线下培训开始时间,Unix时间戳,单位毫秒
end_time Int 是 线下培训结束时间,Unix时间戳,单位毫秒
train_place String 是 线下培训地点,最大长度100字符
total_length Decimal(10,2) 是 培训总时长
lector_id String 是 讲师ID
lector_title String 是 讲师姓名,最大长度100字符
description String 否 线下培训详细描述,最大长度65535字符
outline String 否 线下培训大纲描述,最大长度65535字符
point Decimal(10,2) 否 积分设置,默认0.00
credit Decimal(10,2) 否 学分设置,默认0.00
lector_point Decimal(10,2) 否 讲师积分设置,默认0.00
training_form Int 否 培训方式:
1 线下培训
2 直播培训
默认:1
remind_time Int 否 培训开始前多少时间通知提醒,单位分钟,默认0不提醒,最大位数6
valid_time_second Int 否 二维码刷新时间,单位秒,默认600秒,最大位数8


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "train_id":"376053D7-73B6-44FE-8EF2-4A27E5CC81C6" //创建成功的线下培训ID
    }
}



线下培训指派

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/training/training/assign
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_user_id String 是 操作者UID
training_id String 是 线下培训ID
assign_user_ids String 否 指派人员UIDs,英文逗号间隔字符串,一次最多1000人
assign_user_ids assign_dept_ids 两个参数不能同时为空
assign_dept_ids String 否 指派人员UIDs,英文逗号间隔字符串,一次最多1000个部门
assign_user_ids assign_dept_ids 两个参数不能同时为空


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}