服务端API



获取学习地图分类列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/learningMap/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"  : "1D09EBF2-A8D9-4BDF-8D60-FADE743EBDS1",
                "title" : "分类标题1",
                "parent_id": "1C09EBF2-A8D9-4BDF-8D60-FADE743E1501",
                "create_time": 1546565453000,
            },
          	{
                "uuid"  : "2E09EBF2-A8D9-4BDF-8D60-FADE743ETYR2",
                "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/learningMap/learningMap/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
start_time Int 是 学习地图创建时间的查询起始时间,Unix时间戳,单位毫秒
end_time Int 是 学习地图创建时间的查询结束时间,Unix时间戳,单位毫秒
注意:起始与结束时间差不超365天
certificate_id String 否 关联证书ID
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",
                "certificate_id": "100619E7-5004-464D-A80A-D9D2DFA4F271",
                "description"  : '学习地图攻略',
                "stage_number" : 1,
                "publish_time" : 1546565453000,
                "open_time"    : 1609957197000,
                "learning_num" : 1,
                "finish_num"   : 1,
                "count_meta"    : {
                    "course"  : 1,
                    "exam"    : 1,
                    "survey"  : 0,
                    "training": 0
                },
                "pc_url": "https://saas.eduto.com/pcHome/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=trainingCourse&uuid=3B71E903-8E57-46C5-B3AB-5A7B8A637F94",
                "mobile_url": "https://saas.eduto.com/mobile/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=trainingCourse&uuid=3B71E903-8E57-46C5-B3AB-5A7B8A637F94"
            },
          	{
                "uuid"  : "学习地图唯一ID",
                "title" : "学习地图标题",
                "category_id": "1C09EBF2-A8D9-4BDF-8D60-FADE743E1508",
                "certificate_id": "200619E7-5004-464D-A80A-D9D2DFA4F272",
                "description"  : '学习地图攻略',
                "stage_number" : 1,
                "publish_time" : 1546565453000,
                "open_time"    : 1609957197000,
                "learning_num" : 1,
                "finish_num"   : 1,
                "count_meta"    : {
                    "course"  : 1,
                    "exam"    : 1,
                    "survey"  : 0,
                    "training": 0
                },
                "pc_url": "https://saas.eduto.com/pcHome/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=trainingCourse&uuid=3B71E903-8E57-46C5-B3AB-5A7B8A637F94",
                "mobile_url": "https://saas.eduto.com/mobile/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=trainingCourse&uuid=3B71E903-8E57-46C5-B3AB-5A7B8A637F94"
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
uuid String 学习地图ID,最大长度36字符
title String 学习地图标题,最大长度255字符
category_id String 学习地图分类ID,最大长度36字符
certificate_id String 关联证书ID,最大长度36字符
description String 学习地图攻略,最大长度65535字符
stage_number Int 学习地图中设置的阶段数量,最大位数11
publish_time Int 学习地图发布时间,Unix时间戳,单位毫秒
open_time Int 学习地图设置的开启时间,Unix时间戳,单位毫秒,0为不限制
learning_num Int 学习人数,最大位数11
finish_num Int 完成人数,最大位数11
count_meta Array 学习地图中各项内容的数量:
course :课程数量
exam   :考试数量
survey  :问卷数量
training:培训数量
pc_url String pc端跳转链接
mobile_url String 移动端跳转链接
create_time Int 创建时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取学习地图阶段列表

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

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

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "map_id"       : "1C09EBF2-A8D9-4BDF-8D60-FADE743E1508",
                "uuid"         : "100619E7-5004-464D-A80A-D9D2DFA4F271",
                "title"        : "阶段标题",
                "description"  : "阶段描述",
                "cycle"        : 7,
                "display"      : 1,
                "count_meta"    : {
                    "course"  : 1,
                    "exam"    : 1,
                    "survey"  : 0,
                    "training": 0
                }
            },
          	{
                "map_id"       : "1C09EBF2-A8D9-4BDF-8D60-FADE743E1508",
                "uuid"         : "200619E7-5004-464D-A80A-D9D2DFA4F272",
                "title"        : "阶段标题",
                "description"  : "阶段描述",
                "cycle"        : 7,
                "display"      : 2,
                "count_meta"    : {
                    "course"  : 1,
                    "exam"    : 1,
                    "survey"  : 0,
                    "training": 0
                }
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
map_id String 学习地图ID,最大长度36字符
uuid String 阶段唯一ID,最大长度36字符
title String 阶段标题,最大长度255字符
description String 阶段攻略,最大长度65535字符
cycle Int 阶段周期,单位天,0为不限制,最大位数6
display Int 阶段排序,正序,最大位数6
count_meta Array 学习地图中各项内容的数量:
course :课程数量
exam   :考试数量
survey  :问卷数量
training:培训数量
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取学习地图阶段内容列表

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

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

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "map_id"        : "1C09EBF2-A8D9-4BDF-8D60-FADE743E1508",
                "stage_id"      : "100619E7-5004-464D-A80A-D9D2DFA4F271",
                "type"          : "course",
                "target_id"     : "1F6EE947-E88B-4EC3-88A8-A76825532FC1",
                "target_title"  : "阶段内容标题",
                "display"       : 1,
                "start_time"    : 1546565453000,
                "end_time"      : 1609957197000
            },
          	{
                "map_id"        : "1C09EBF2-A8D9-4BDF-8D60-FADE743E1508",
                "stage_id"      : "100619E7-5004-464D-A80A-D9D2DFA4F271",
                "type"          : "course",
                "target_id"     : "2F6EE947-E88B-4EC3-88A8-A76825532FC2",
                "target_title"  : "阶段内容标题",
                "display"       : 1,
                "start_time"    : 1546565453000,
                "end_time"      : 1609957197000
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
map_id String 学习地图ID,最大长度36字符
stage_id String 学习地图阶段ID,最大长度36字符
type String 阶段内容类型
course 课程
exam 考试
training 线下培训
survey 调查评估
target_id String 阶段内容ID,最大长度36字符
target_title String 阶段内容标题,最大长度255字符
display Int 阶段排序,正序
start_time Int 开始时间,如线下培训开始时间,Unix时间戳,单位毫秒
end_time Int 结束时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取学习地图学员学习结果列表

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

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

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [ 
            {
                "dept_user_id"      : "11121033-3F87-48E3-B1B7-EBEF3339B8C1", 
                "progress"          : 0,
                "eligible_status"   : "fail",
                "learn_status"      : "learning",
                "finish_stage_count": 0,
                "miss_count"        : 0,
                "finish_time"       : 1659957197000,
                "use_days"          : 0,
                "is_extension"      : 0,
                "start_time"        : 1546565453000,
                "end_time"          : 1669957197000
            },
          	{
                "dept_user_id"      : "21121033-3F87-48E3-B1B7-EBEF3339B8C2", 
                "progress"          : 0,
                "eligible_status"   : "fail",
                "learn_status"      : "learning",
                "finish_stage_count": 0,
                "miss_count"        : 0,
                "finish_time"       : 1659957197000,
                "use_days"          : 0,
                "is_extension"      : 0,
                "start_time"        : 1546565453000,
                "end_time"          : 1669957197000
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
dept_user_id String 用户ID,最大长度64字符
progress Int 学习总进度,百分比数字1-100
eligible_status String 合格状态:
eligible 合格
fail 不合格
learn_status String 学习状态:
learning 学习中
finished 已完成
miss_count Int 已错过完成时间的内容项数量(如过期未参与的线下培训),最大位数11
finish_time Int 完成时间,Unix时间戳,单位毫秒,未完成为0
use_days Int 完成学习用时,单位天,最大位数8
is_extension Int 是否延期完成学习:
0 按时完成
1 延期完成
start_time Int 开始时间,如线下培训开始时间,Unix时间戳,单位毫秒
end_time Int 预计结束时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取学习地图阶段学员学习结果列表

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

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
map_id String 是 学习地图ID,最大长度36字符
stage_id String 是 学习地图阶段ID,最大长度36字符
userid_list String 否 员工在企业内的UserID列表,多个UserId用英文逗号隔开
start_time Int 否 学员完成学习地图阶段时间的查询起始时间,Unix时间戳,单位毫秒
注意:开始时间与当前时间差不能大于365天
end_time Int 否 学员完成学习地图阶段时间的查询结束时间,Unix时间戳,单位毫秒
注意:起始与结束时间差不超7天
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [ 
            {
                "dept_user_id"      : "11121033-3F87-48E3-B1B7-EBEF3339B8C1",
                "progress"          : 0,
                "learn_status"      : "learning",
                "finish_count"      : 0,
                "miss_item_count"   : 0,
                "finish_time"       : 1659957197000,
                "use_days"          : 0,
                "is_extension"      : 0,
                "start_time"        : 1546565453000,
                "end_time"          : 1669957197000
            },
          	{
                "dept_user_id"      : "21121033-3F87-48E3-B1B7-EBEF3339B8C2",
                "progress"          : 0,
                "learn_status"      : "learning",
                "finish_count"      : 0,
                "miss_item_count"   : 0,
                "finish_time"       : 1659957197000,
                "use_days"          : 0,
                "is_extension"      : 0,
                "start_time"        : 1546565453000,
                "end_time"          : 1669957197000
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
dept_user_id String 用户ID,最长64位字符
progress Int 学习总进度,百分比数字1-100
learn_status String 学习状态:
learning 学习中
finished 已完成
finish_count Int 完成项数量,最大位数11
miss_item_count Int 已错过完成时间的内容项数量(如过期未参与的线下培训),最大位数11
finish_time Int 完成时间,Unix时间戳,单位毫秒,未完成为0
use_days Int 完成学习用时,单位天,最大位数11
is_extension Int 是否延期完成学习:
0 按时完成
1 延期完成
start_time Int 开始时间,如线下培训开始时间,Unix时间戳,单位毫秒
end_time Int 预计完成时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取学习地图阶段内容学员学习结果列表

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

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
map_id String 是 学习地图ID
stage_id String 是 学习地图阶段ID
target_id String 是 学习地图阶段内容ID
userid_list String 否 员工在企业内的UserID列表,多个UserId用英文逗号隔开
start_time Int 否 学员完成学习地图阶段时间的查询起始时间,Unix时间戳,单位毫秒
注意:开始时间与当前时间差不能大于365天
end_time Int 否 学员完成学习地图阶段时间的查询结束时间,Unix时间戳,单位毫秒
注意:起始与结束时间差不超7天
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [ 
            {
                "dept_user_id": "11121033-3F87-48E3-B1B7-EBEF3339B8C1",
                "learn_status": "learning",
                "progress": 0,
                "score": 0,
                "pass_status" : 0,
                "start_time": 1546565453000,
                "finish_time": 1659957197000,
            },
          	{
                "dept_user_id": "21121033-3F87-48E3-B1B7-EBEF3339B8C2",
                "learn_status": "finished",
                "progress": 0,
                "score": 0,
                "pass_status" : 0,
                "start_time": 1546565453000,
                "finish_time": 1659957197000,
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
dept_user_id String 用户ID,最长64位字符
learn_status String 学习状态:
learning 学习中
finished 已完成
progress Int 学习总进度,百分比数字1-100
score Int 考试成绩,最大长度11
pass_status String 学习状态:
0
completed
evaluate
none
not_attempt
passed
reviewing
signUp
unpassed
start_time Int 开始时间,Unix时间戳,单位毫秒
finish_time Int 完成时间,Unix时间戳,单位毫秒,未完成为0
has_more Int 是否还有数据没返回:
1 还有
0 没有