paper-内容研发做课APP接口.md 4.2 KB

996.icu

内容研发做课APP 功能接口

1. 【新接口,只有在内容研发做课APP上使用】根据书名,模糊查询书列表接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/manage/develop/getDevelopBook?access_token=76oRwgOqPb&folderName=智能四会单词课 教科版
  • Method: GET
  • RequestParam:
参数 类型 说明
folderName string 书的文件夹名
  • ResponseBody:
{
    "status": "SUCCESS",
    "bookList": [
        {
            "bookId": 298,
            "bookName": "教科版三起三年级上2",                  // 书名
            "folderName": "智能四会单词课 教科版三起三年级上2",   // 书的文件夹名
            "bookCover": "ec62d845c9b1ea1c8f10736cfc368240",  // 书封面
            "paperAmount": 19                                 // 书中课数量
        }
    ]
}

查询状态statusstatus=SUCCESS表示查询成功,status=ERROR表示查询失败。

2. 【新接口,只有在内容研发做课APP上使用】根据书ID,查询书中全部课程的列表
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/manage/develop/getPaperListByBookId?access_token=76oRwgOqPb&bookId=300
  • Method: GET
  • RequestParam:
参数 类型 说明
bookId long 书的ID
{
  "status": "SUCCESS",
  "bookId": 300,
  "paperSummaryList": [
    {
      "paperId": "L3NoYXJlL3N2bi_mmbrog73lm5vkvJrljZXor43or74g5pWZ56eR54mI5LiJ6LW35Zub5bm057qn5LiKMS8wMDEu5pWZ56eR54mI5Zub5bm057qn5LiKTTFVMS0xLnhsc3g",
      "paperName": "教科版四年级上M1U1-1",
      "paperCover": "e675272ec96715e27a27d23ca8d8aec2",
      "paperOrderIndex": 1,
      "paperHasOpen": false,
      "paperProjectName": "/share/svn/智能四会单词课 教科版三起四年级上1/001.教科版四年级上M1U1-1.xlsx",
      "paperStatus": "NO_SUBMIT",
      "pageIdTotal": [
        "1"
      ],
      "pageIdFinished": [],
      "pageIdUnFinished": [
        "1"
      ]
    },
    {
      "paperId": "L3NoYXJlL3N2bi_mmbrog73lm5vkvJrljZXor43or74g5pWZ56eR54mI5LiJ6LW35Zub5bm057qn5LiKMS8wMDIu5pWZ56eR54mI5Zub5bm057qn5LiKTTFVMS0yLnhsc3g",
      "paperName": "教科版四年级上M1U1-2",
      "paperCover": "fcb554371e003ac108525796ebc15438",
      "paperOrderIndex": 2,
      "paperHasOpen": false,
      "paperProjectName": "/share/svn/智能四会单词课 教科版三起四年级上1/002.教科版四年级上M1U1-2.xlsx",
      "paperStatus": "NO_SUBMIT",
      "pageIdTotal": [
        "2",
        "3"
      ],
      "pageIdFinished": [],
      "pageIdUnFinished": [
        "2",
        "3"
      ]
    }
  ]
}

新旧paper课主观题完成状态字段对比

状态 旧接口字段值subjective_finished_status 新接口字段值paperStatus
没有提交记录:不显示 zero NO_SUBMIT
只提交部分作业:显示红色感叹哈 half PART_SUBMIT
正在校审中:显示黄色等待 supervising SUPERVISING
校审结束:显示小绿旗 total SUPERVISING_FINISHED
3. 【旧接口,只有在内容研发做课APP上使用】拍照提交接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/student/submitPaperTask?access_token={{access_token}}&submitType=SUBMIT_PUBLIC_SCHOOL&appIsExperience=true
  • Method: POST
  • RequestBody:
{
  "paperId": "submit_paperId",
  "imageUrl": "submit_imageUrl"
}
4. 【旧接口,只有在内容研发做课APP上使用】清除学生上传纸质作业记录
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/manage/develop/clean/student/spoor/inner/only?access_token=76oRwgOqPb
  • Method: POST
5. 【旧接口,需要在指定接口上拼接指定参数】参数:appIsExperience = true
  1. APP轮询获取纸质作业识别结果的接口:/paper/ai/schedule/checkSubmitPaper
  2. 获取纸质作业主观题识别结果的接口:/paper/student/paper_detail

说明:如果appIsExperience = true,表示该请求是免校审APP发出,走免校审逻辑;
如果不传该参数或者appIsExperience = false,表示是从正式APP发出,不走免校审逻辑,识别结果需要校审APP提交后才能看见;