paper-智能四会课接口.md 3.3 KB

996.icu

纸质作业智能四会课程接口

1. 首页获取四会单词课摘要接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookSummary?access_token=tqgdSAzuFF
  • Method: GET
  • RequestBody:

  • ResponseBody:

{
    "userId": 100000006030,
    "flagNoPaperTextbook": false,  // 是否显示"智能四会课程"这个模块,true:不显示,false:显示。
    "summaryList": [
        {
            "typeDesc": "智能同步四会单词课",
            "type": "PAPER_TEXTBOOK_WORD",
            "amountCourse": 19,
            "courseName": "北师版高中必修4 Learning to learn",
            "courseCover": "340f6c485dbb9268f2b46f017708e4de"
        }
    ]
}

summaryList集合里类对象的属性:

public static class TextBookSummary {
    private String type;
    private String typeDesc;
    private Integer amountCourse;       // 课程数量
    private Integer amountFresh = 0;    // 未查看的数量
    private String courseName;          // 纸质作业课程名称
    private String courseCover;         // 纸质作业课程封面
    private String finishedRate;        // 课程完成率
    private List<String> nationalKnowledge = new ArrayList<>();
}
2. 点击进入四会单词课模块,进入课程列表接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookList?access_token=tqgdSAzuFF&textbookType=PAPER_TEXTBOOK_WORD
  • Method: GET
  • RequestParam:
参数 类型 说明
textbookType 枚举 教材分类,目前只有PAPER_TEXTBOOK_WORD单词类型
  • ResponseBody:
{
    "typeDesc": "智能同步四会单词课",
    "courseTypeV3": "PAPER_TEXTBOOK_WORD",
    "paperList": []
}

textbookList集合中对象的属性:

public static class CourseSummary {
    private String paperId;             // 纸质作业课程ID
    private String paperName;           // 纸质作业名称
    private String paperCover;          // 纸质作业课程封面
    private Boolean paperIsFresh;       // 纸质作业是否查看过标识

    private PaperSubjectiveStatusEnum paperStatus;                  // 纸质作业识别状态
    private List<String> pageIdTotal = new ArrayList<>();           // 纸质作业客观题全部页码
    private List<String> pageIdFinished = new ArrayList<>();        // 纸质作业客观题已识别完成的页码
    private List<String> pageIdUnFinished = new ArrayList<>();      // 纸质作业客观题未识别的页码

    private Boolean svHasConsume;       // 自主学习是否练习
    private Course.Mark courseGrade;    // 自主学习成绩,枚举值:A_PLUS, A, B, C, D

    private String courseId;            // 自主学习课程ID
    private Boolean flagNotes;          // 自主学习 是否有微课
    private List<String> nationalKnowledge = new ArrayList<>();     // 自主学习知识点

    private DateTime updateTime;        // 自主学习 or 纸质作业的更新时间
}
3. 点击进入四会单词课模块,上报红点消失的接口

上报红点消失的接口还使用原来接口即可,请求URL如下:

  • URL:{{localhost}}/boxfish-wudaokou-paper/paper/ai/subjective/recoverFreshFlag?access_token=tqgdSAzuFF