huayandong / recommend-api

纸质作业接口文档

• 日期：20181228
• APP：学生端
• 版本：学生端X.X.0版（发布会版本）

1. 首页一级页面接口

• URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/getPaperSummary?access_token={{token}}
• Method: POST
• RequestBody:

参数	类型	说明
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
• RequestBody:

参数	类型	说明
courseTypeV3	String	进入培优课类型：WORD："智能单词课"，KNOWLEDGE："智能知识点课"，READING："智能阅读课"
gradeList	数组	学生年级：如果不区分上下学期，则传入上下两个学期的年级, 填写格式如下：

  // 四年级下学期参数格式
{
    "gradeList":[
        "GRADE_4_B"
    ]
}

  // 九年级参数格式
{
    "gradeList":[
        "GRADE_9_A", 
        "GRADE_9_B"
    ]
}

3. 点击进入二级页面，上报取消红点显示接口

• URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/subjective/recoverFreshFlag?access_token={{token}}
• Method: POST
• RequestBody:

参数	类型	说明
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
• RequestParam:

参数	类型	说明
courseId	String	自主学习课程ID
studentId	Long

6. 外交提交阅读校审结果

• URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/reading/submitReadingTask
• Method: POST
• RequestBody:

参数	类型	说明
teacherId	Long	老师ID
studentId	Long	学生ID
paperId	string	纸质作业课程ID
questionId	string	问题的ID，不是返回体中的"questionIdShow"！
questionIsCorrect	boolean	true：外教认为是对的，false：外教认为是错的

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}}&submitType={{submitType}}
• Method: POST
• RequestBody:

参数	类型	说明
paperId	String	"自有练习册"该字段为null，"公立学校"该字段必须有值；
imageUrl	String	图片地址

submitType的枚举值为：
    SUBMIT_PUBLIC_SCHOOL,   // 公立学校提交
    SUBMIT_OPEN_PAPER,      // 自有练习册提交
    SUBMIT_PAPER_V1         // 智能培优课(智能三件套)提交

8. 根据书名查看书中全部课程 for 旺旺

• URL: {{localhost}}/boxfish-wudaokou-paper/paper/manage/getPaperListByBookName?bookName={{bookName}}
• Method: GET
• RequestParam:

参数	类型	说明
bookName	String	书名

9. APP轮询获取识别结果接口

• URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/schedule/checkSubmitPaper?access_token=kuDb43NH1c
• Method: POST
• RequestBody

{
    "imageUrlList":[
    "image/9200/20181229/1546064409.jpg",
    "image/9200/20181229/1546064415.jpg",
    "image/9200/20181229/1546064423.jpg"
    ]
}

Response:

    private Boolean continueSchedule = false;   // 是否继续轮询标识

    private ImageEmptyType emptyType;           // 为空类型：枚举值
    private Boolean submitIsComplete;           // 是否提交完整

    private String paperId;
    private String paperName;

    private String courseId;

    private Boolean flagNotes;
    private Boolean svHasConsume;
    private String gradeDesc;                   // 课程年级 + 类型： "四年级下智能知识点课"
    private CourseQrCodeEntity.CourseType courseTypeV3;         // 智能培优课类型
    private List<String> nationalKnowledge = new ArrayList<>();

    private List<Integer> totalPageId = new ArrayList<>();
    private List<Integer> finishedPageId = new ArrayList<>();
    private List<Integer> unFinishedPageId = new ArrayList<>();

    private List<ImagePart> successImageList = new ArrayList<>();

返回体中新增加字段：continueSchedule,当continueSchedule=true时，APP需要继续轮询轮询；continueSchedule=false,停止轮询，同时返回体重有需要显示的数据

ImageEmptyType枚举值为：

    PAPER_SUBMIT_ZERO,          // 学生拍的题都识别失败
    PAPER_SUBMIT_MULTI,         // 学生拍了多套题
    PAPER_NOT_PAPER_V1,         // 学生拍的题不是智能三件套的题
    PAPER_NOT_PURCHASE;         // 学生拍的是三件套的题，但是不属于自己购买的三件套