开放平台 |

API文档

所有的API仅供内部开发使用.

基础数据结构

课程类别/授课领域(Course Type)

名称 类型 示例值 描述
courseTypeId Integer 1 课程类别的ID, 仅供数据库索引使用.
courseTypeSlug String web-development 课程类别的唯一英文简写, 多用于查询和筛选.
courseTypeName String Web开发 课程类别的名称.

培训课(Lecture)

名称 类型 示例值 描述
lectureId Integer 100 培训课的ID.
createTime DateTime 2014-07-21 09:38:51 培训课的创建时间.
courseId Integer 100 培训课对应的课程ID.
courseName String 技术管理者训练营 课程名称.
isPublic Boolean 1 是否为公开课.
courseTypeId Integer 21 课程类别的ID.
courseTypeSlug String team-management 课程类别的唯一英文简写.
courseTypeName String 团队管理 课程类别的名称.
teacherId Integer 100 讲师的用户ID.
teacherName String 杨锋镝 讲师的姓名.
startTime DateTime 2014-07-16 08:30:00 培训课的开始时间.
endTime DateTime 2014-07-18 17:00:00 培训课的结束时间.
lectureRegion String 华东地区 培训课的开课地点所在地区.
lectureProvince String 浙江省 培训课的开课地点所在省份(或直辖市).
lectureCity String 杭州市 培训课的开课地点所在城市(对直辖市, 该值为null).
lectureAddress String 浙江大学紫金港校区 培训课开课地点的具体地址.
minCapcity Integer 20 培训课的最小开班人数.
maxCapcity Integer 200 培训课的最大容纳人数.
participants Integer 10 当前培训的报名人数, 当调用部分API时, 该值为null.
expense Integer 5800 参加培训课的费用.
audience String 项目经理 课程的推荐听众.
brief String 课程的概述.

课程(Course)

名称 类型 示例值 描述
courseId Integer 100 培训课对应的课程ID.
courseName String 技术管理者训练营 课程名称.
isPublic Boolean 1 是否为公开课.
courseTypeId Integer 21 课程类别的ID.
courseTypeSlug String team-management 课程类别的唯一英文简写.
courseTypeName String 团队管理 课程类别的名称.
teacherId Integer 100 讲师的用户ID.
teacherName String 杨锋镝 讲师的姓名.
courseCycle Integer 2 课程的培训周期, 即开始到结束的时间(单位: 天).
audience String 项目经理 课程的推荐听众.
brief String 课程的概述.

课程模块(Course Module)

名称 类型 示例值 描述
courseModuleId Integer 100 课程模块的ID.
courseModuleName String 技术管理者的角色认知 课程模块的名称.
teacherId Integer 100 讲师的用户ID.
courseModuleCycle Integer 120 课程模块的培训周期, 即开始到结束的时间(单位: 分钟).
courseModuleStartTime DateTime 2014-07-16 08:30:00 课程模块开始时间, 在[课程API]时为null.
courseModuleEndTime DateTime 2014-07-16 10:30:00 课程模块结束时间, 在[课程API]时为null.
courseModuleBrief String 课程模块的概述.
courseModuleOutline String 课程模块的大纲.

评论(Comment)

名称 类型 示例值 描述
commentId Integer 100 评论的ID.
lectureId Integer 100 培训的ID, 在参加某培训课后发表的评论.
courseId Integer 100 课程的ID, 表示对某课程的评论.
reviewerUid Integer 1001 评论发布者的用户ID.
reviewerUsername String zjhzxhz 评论发布者的用户名.
commentTime DateTime 2014-08-05 22:24:15 评论发布的时间.
ranking Integer 4 对该课程的打分, 取值范围是[1, 5].
detail String 评价的具体内容.

讲师(Teacher)

名称 类型 示例值 描述
uid Integer 1003 讲师的用户ID.
teacherName String 朱少民 讲师的姓名.
isApproved Boolean 1 讲师资料是否已通过审核.
brief String 讲师的自我简介.
avatar String /img/avatars/u-1003.jpg 讲师用户头像的路径.
region String 华东地区 讲师所在地区; 该值一般情况下为null.
province String 上海市 讲师所在省份(或直辖市); 该值一般情况下为null.
city String null 讲师所在城市(对直辖市, 该值为null); 该值一般情况下为null.
company String 曾任思科网讯QA总监 讲师所在公司或曾就职的公司及职位
phone String 讲师的移动电话; 该值一般情况下为null.
weibo String 讲师的微博账号; 该值在一般情况下为null.

培训动态(Post)

名称 类型 示例值 描述
postId Integer 1 培训动态的ID.
postCategoryId Integer 1 培训动态分类的ID.
postCategorySlug String uncategorized 培训动态分类的唯一英文简写.
postCategoryName String 未分类 培训动态分类的名称.
postDate DateTime 2014-07-05 23:59:15 培训动态的发布时间.
postTitle String 培训动态的标题.
postContent String 培训动态的正文内容.

培训动态分类(Post Category)

名称 类型 示例值 描述
postCategoryId Integer 1 培训动态分类的ID, 仅供数据库索引使用.
postCategorySlug String uncatalogued 培训动态分类的唯一英文简写, 多用于查询和筛选.
postCategoryName String 未分类 培训动态分类的名称.

培训课API

筛选培训课

  • 描述: 根据培训课筛选条件筛选出符合条件的培训课.
  • URL: https://courseocean.infinitescript.com/training/getLectures
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
category String all 课程类别, 取值请参见CourseType数据结构.
startTime DateTime 当前时间(2020-07-07 14:10) 培训开始时间.
endTime DateTime 培训结束时间.
region String 培训开设地区.
province String 培训开设省份(或直辖市).
city String 培训开设城市(对直辖市, 该值为null).
page Integer 1 查询结果页码, 用于分页显示查询结果.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
lectures Array 一个包含若干Lecture(培训课)对象的数组.

                            
                        

获取培训课详细信息

  • 描述: 根据培训课ID获取该培训课的详细信息.
  • URL: https://courseocean.infinitescript.com/training/getLecture
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
lectureId Integer 培训课的ID.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
lecture Lecture 一个Lecture(培训课)对象, 包含对该培训课的描述信息(其中的teacherName字段为总是为null).
teacher Teacher 一个Teacher(讲师)对象, 包含对该培训课讲师的描述信息.
courseModules Array 一个Course Module(课程模块)对象的数组, 包含该培训课所包含的课程模块的描述信息(并包含每个课程模块具体的起止时间).
lectures Array 一个包含若干Lecture(培训课)对象的数组, 表示该课程在过去及将来的其他培训课.
attendance Attendance 一个包含Attendance对象, 包含两个字段: hasAttended(当前用户是否报名参加)和participants(当前报名人数).

                            
                        

参加培训课

  • 该API仅限已登录的用户使用.
  • 描述: 报名参加某培训课.
  • URL: https://courseocean.infinitescript.com/training/attendLecture
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
lectureId Integer 培训课的ID.
participants Integer 1 报名参加的人数, 对于非企业用户, 该值为1.
名称 类型 描述
isSuccessful Boolean 报名是否成功, 若报名失败则为false.

                            
                        

课程API

筛选课程

  • 描述: 根据课程筛选条件筛选出符合条件的课程.
  • URL: https://courseocean.infinitescript.com/training/getCourses
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
category String all 课程类别, 取值请参见CourseType数据结构.
page Integer 1 查询结果页码, 用于分页显示查询结果.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
courses Array 一个包含若干Course(课程)对象的数组.

                            
                        

获取课程详细信息

  • 描述: 根据课程ID获取该课程的详细信息.
  • URL: https://courseocean.infinitescript.com/training/getCourse
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
courseId Integer 课程的ID.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
course Course 一个Course(课程)对象, 包含对该课程的描述信息(其中的teacherName字段为总是为null).
teacher Teacher 一个Teacher(讲师)对象, 包含对该课程讲师的描述信息.
courseModules Array 一个Course Module(课程模块)对象的数组, 其中课程模块的起始和结束时间始终为null.
lectures Array 一个包含若干Lecture(培训课)对象的数组, 表示该课程在过去及将来的其他培训课.

                            
                        

评论API

获取课程评价

  • 描述: 根据课程ID获取该课程的评论信息.
  • URL: https://courseocean.infinitescript.com/training/getComments
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
courseId Integer 课程的ID.
page Integer 1 查询结果页码, 用于分页显示查询结果.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
comments Array 一个包含若干Comment(评论)对象的数组.

                            
                        

讲师API

筛选讲师

  • 描述: 根据讲师的筛选条件筛选出符合条件的讲师.
  • URL: https://courseocean.infinitescript.com/training/getTeachers
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
category String all 授课领域, 取值请参见CourseType数据结构.
page Integer 1 查询结果页码, 用于分页显示查询结果.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
teachers Array 一个包含若干Teacher(讲师)对象的数组, 仅包含uid(用户ID), teacherName(讲师姓名), teachingField(授课领域), company(公司及职位)字段.

                            
                        

获取讲师详细信息

  • 描述: 根据讲师的用户ID获取该讲师的详细信息.
  • URL: https://courseocean.infinitescript.com/training/getTeacher
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
teacherId Integer 讲师的用户ID.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
teacher Teacher 一个Teacher(讲师)对象, 包含对该课程讲师的描述信息.
course Course 一个Course(课程)对象, 包含对该课程的描述信息(其中的teacherName字段为总是为null).

                            
                        

培训动态API

筛选培训动态

  • 描述: 根据培训动态筛选条件筛选出符合条件的培训动态.
  • URL: https://courseocean.infinitescript.com/training/getPosts
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
category String all 培训动态分类, 取值请参见PostCategory数据结构.
page Integer 1 查询结果页码, 用于分页显示查询结果.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
posts Array 一个包含若干Post(培训动态)对象的数组.

                            
                        

获取培训动态详细信息

  • 描述: 根据培训动态ID获取该培训动态的详细信息.
  • URL: https://courseocean.infinitescript.com/training/getPost
  • 数据格式: JSON
  • 方法: HTTP GET
名称 类型 是否必需 默认值 描述
postId Integer 培训动态的ID.
名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
post Post 一个Post(培训动态)对象, 包含对该培训动态的描述信息(其中的teacherName字段为总是为null).
posts Array 一个包含若干Post(培训动态)对象的数组, 表示与该培训动态相关的其他培训动态.

                            
                        

用户API

用户登录

  • 描述: 处理用户登录请求.
  • URL: https://courseocean.infinitescript.com/accounts/doLogin
  • 数据格式: JSON
  • 方法: HTTP Post
名称 类型 是否必需 默认值 描述
username String 用户名或电子邮件地址.
password String 密码, 请使用MD5加密后传输.
rememberMe Boolean false 是否长时间保存登录状态.
名称 类型 描述
isSuccessful Boolean 登录是否成功, 若登录失败, 则为false.
isUsernameEmpty Boolean 用户名是否为空
isPasswordEmpty Boolean 密码是否为空
isAccountValid Boolean 用户名和密码是否正确

                            
                        

用户注册

  • 描述: 处理用户注册请求.
  • URL: https://courseocean.infinitescript.com/accounts/doRegister
  • 数据格式: JSON
  • 方法: HTTP Post
名称 类型 是否必需 默认值 描述
username String 用户名. 长度在6~16字符之间, 由数字字母和下划线组成.
email String 电子邮件地址. 长度不超过64个字符.
password String 密码, 长度在6~16个字符之间. (传输时请不要使用MD5加密)
userGroup String 用户组, 仅为以下三个值之一: { person, teacher, company }.
名称 类型 描述
isSuccessful Boolean 注册是否成功, 若注册失败, 则为false.
isUsernameEmpty Boolean 用户名是否为空.
isUsernameLegal Boolean 用户名是否合法.
isUsernameExists Boolean 用户名是否已存在.
isEmailEmpty Boolean 电子邮件地址是否为空.
isEmailLegal Boolean 电子邮件地址是否合法.
isEmailExists Boolean 电子邮件地址是否已存在.
isPasswordEmpty Boolean 密码是否为空.
isPasswordLegal Boolean 密码是否合法.
isUserGroupLegal Boolean 用户组是否合法.

                            
                        

其他API

获取所有课程类别

  • 描述: 获取全部课程分类的信息.
  • URL: https://courseocean.infinitescript.com/training/getCourseTypes
  • 数据格式: JSON
  • 方法: HTTP GET

该API不需要参数

名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
courseTypes Array 一个包含若干CourseType(课程类别)对象的数组.

                            
                        

获取所有培训动态分类

  • 描述: 获取全部培训动态分类的信息.
  • URL: https://courseocean.infinitescript.com/training/getPostCategories
  • 数据格式: JSON
  • 方法: HTTP GET

该API不需要参数

名称 类型 描述
isSuccessful Boolean 查询是否成功, 若查询失败或结果为空, 则为false.
postCategories Array 一个包含若干PostCategory(培训动态分类)对象的数组.