“金老师的教育网站” 课程资源 Open API文档

jinxuliang2 发表于   2017/3/2 16:07:48,阅读次数: 1886

本文档介绍本网站所提供之在线课程资源Open API的技术细节。

为了方便手机等移动客户端访问,本网站提供基于HTTP的Open API Service。基于这些Open API,手机客户端可以方便地访问本网站所提供的各种学习资源。

由于本网站一直处于快速更新之中,因此,Open API也会随之修改。相应的修改将在本文档中体现。

在线课程API:

  • 提取所有课程清单

发出HTTP GET请求: http://jinxuliang.com/openservice/api/courseservice/course

返回一个Json数组,其格式如下:

[

{"CourseName":"Java程序设计","courseId":"54004d84137e45731c99035b"},

……

]

  • 提取指定课程的相关信息

发出HTTP GET请求: http://jinxuliang.com/openservice/api/courseservice/course/{courseId}

如:

http://jinxuliang.com/openservice/api/courseservice/course/54004d84137e45731c99035b

返回一个Json数组,其格式如下:

[

{"_id":"54004dce137e45731c99035c",

"resourceId":"00000000-0000-0000-0000-000000000000",

"resourceCategory":"CourseModule",

"resourceName":"《Java程序设计》之《编程起步》","url":null},

……

]

  • 提取课程的详细说明

发出HTTP请求:http://jinxuliang.com/openservice/api/courseservice/course/{courseId}/description?needTxt=true

如:http://jinxuliang.com/openservice/api/courseservice/course/54004d84137e45731c99035b/description

返回:

(1)如果needTxt=true,则返回纯文本格式的说明

(2)如果needTxt=false(默认值),则返回一个可能比较长的课程说明,可以包容图片链接等的标准Web网页

  • 获取指定模块的内容清单(包容子模块和资源)

发出HTTP GET请求:http://jinxuliang.com/openservice/api/courseservice/module/{moduleId}

如:http://jinxuliang.com/openservice/api/courseservice/module/5412dcec137e430e98768371

返回一个庞大的Json数组,其格式如下:

[

{"rootVirtualPath":"/course/java/003/ClassAndObject/SlidePic",

"slides":["Snap1.jpg","Snap2.jpg",……,"Snap47.jpg"],

"_id":"5412dd1e137e430e98768372",

"resourceId":"68f55691-1208-4556-97bf-4f4cab8d32b7",

"resourceCategory":"PPTResource",

"resourceName":"《Java程序设计》/《面向对象编程基础》:第1讲 《类和对象》",

"url":"/course/PPT/Show/5412dd1e137e430e98768372"},

……

]

  • 提取指定模块的说明信息

发出HTTP GET请求:http://jinxuliang.com/openservice/api/courseservice/module/{moduleId}/description?needTxt=true

如:

http://jinxuliang.com/openservice/api/courseservice/module/5412dcec137e430e98768371/description?needTxt=true

返回:

(1)如果needTxt=true,则返回纯文本格式的说明

(2)如果needTxt=false(默认值),则返回一个可能比较长的课程说明,可以包容图片链接等的标准Web网页

  • 提取指定资源的说明信息

发出HTTP Get请求: http://jinxuliang.com/openservice/api/courseservice/resource/{resourceId}/description?needTxt=true

如:

http://jinxuliang.com/openservice/api/courseservice/resource/546d5c35137e43118499f8a9/description?needTxt=true

返回:

(1)如果needTxt=true,则返回纯文本格式的说明

(2)如果needTxt=false(默认值),则返回一个可能比较长的课程说明,可以包容图片链接等的标准Web网页


附件清单



评论于: