paper-20181228.md 3.29 KB

纸质作业接口文档

  • 日期:20181228
  • APP:学生端
  • 版本:学生端X.X.0版(发布会版本)
1. 首页一级页面接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/getPaperSummary?access_token={{token}}
  • Method: POST
  • Request:
参数 类型 说明
gradeList 数组 学生年级:如果不区分上下学期,则传入上下两个学期的年级
  // 四年级下学期
{
    "gradeList":[
        "GRADE_4_B"
    ]
}

  // 九年级
{
    "gradeList":[
        "GRADE_9_A", 
        "GRADE_9_B"
    ]
}

2. 智能培优课课程列表页面,二级列表页面
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/getPaperList?access_token={{token}}
  • Method: POST
  • Request:
参数 类型 说明
courseTypeV3 String 进入培优课类型:WORD:"智能单词课",KNOWLEDGE:"智能知识点课",READING:"智能阅读课"
gradeList 数组 学生年级:如果不区分上下学期,则传入上下两个学期的年级
3. 点击进入二级页面,上报取消红点显示接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/subjective/recoverFreshFlag?access_token={{token}}
  • Method: POST
  • Request:
参数 类型 说明
courseTypeV3 String 进入培优课类型:WORD:"智能单词课",KNOWLEDGE:"智能知识点课",READING:"智能阅读课"
gradeList 数组 学生年级:如果不区分上下学期,则传入上下两个学期的年级
4. 扫描二维码,获取自主学习课程信息
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/getQrCourseInfo?access_token={{token}}&qrCode={{qrCode}}
  • Method: GET
  • Request:
参数 类型 说明
qrCode String 二维码code
5. 外交端获取阅读题文本
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/teacher/getReadingText
  • Method: GET
  • Request:
参数 类型 说明
courseId String 自主学习课程ID
studentId Long
6. 外交提交阅读校审结果
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/reading/submitReadingTask
  • Method: POST
  • Request:
参数 类型 说明
teacherId String 自主学习课程ID
studentId Long
paperId string 纸质作业课程ID
questionId string
questionIsCorrect boolean
7. 纸质作业统一提交接口

之前"公立学校"和"自有练习册"提交纸质作业分为两个提交接口,但是后来发现两个接口可以合并,为了方便维护,推荐使用统一提交接口。

  • 公立学校提交URL: {{localhost}}/boxfish-wudaokou-paper/paper/student/question_subjective/submit
  • 自有练习册提交URL:{{localhost}}/boxfish-wudaokou-paper/paper/open/image/submit
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/student/submitPaperTask?access_token={{access_token}}
  • Method: POST
  • Request:
参数 类型 说明
paperId String "自有练习册"该字段为null,"公立学校"该字段必须有值;
imageUrl String 图片地址
8. 根据书名查看书中全部课程 for 旺旺
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/manage/getPaperListByBookName?bookName={{bookName}}
  • Method: GET
  • Request:
参数 类型 说明
bookName String 书名