huayandong / recommend-api

获取学员身份信息接口

1. 学生端接口

• URL: {{localhost}}/boxfish-online-card/member/info/getMemberInfo?access_token={{token}}

• Method: GET

• ResponseBody:

  public class MemberSummary implements BeanToJson {
  private Long userId;
  private MemberTypeEnum memberType;      // 学员身份
  private DateTime expireTimeMember;      // 学员过期时间
  
  private MemberTypeEnum memberTypeV2;    // 新版本用户身份
  
  private Integer amountClassSvValid;     // 外教练习 剩余次数
  private Integer amountClassSvFinished;  // 外教练习 完成次数
  private DateTime expireTimeClassSv;     // 外教练习 过期时间
  
  private Integer amountClassSv10Valid;   // 外教练习 10分钟 剩余次数
  
  private String expireDescClassSv5;      // 外教练习5分钟 过期描述
  private String expireDescClassSv10;     // 外教练习10分钟 过期描述
  
  private Integer amountExamOral;         // 口语考试 剩余次数
  private DateTime expireTimeExamOral;    // 口语考试 过期时间
  
  private Integer amountOpenCn;           // 中教名师课 剩余次数
  private DateTime expireTimeOpenCn;      // 中教名师课 过期时间
  private String expireDescOpenCn;        // 中教名师课 过期描述
  
  private Integer amountOpenUs;           // 外教名师课 剩余次数
  private DateTime expireTimeOpenUs;      // 外教名师课 过期时间
  private String expireDescOpenUs;        // 外教名师课 过期描述
  
  private Boolean flagPaperV1Auth;        // 纸质三件套 权限
  private DateTime expireTimePaperV1;     // 智能三件套 过期时间
  
  private Long classSmallId;              // 小班课ID
  private String classSmallName;          // 小班课名称
  private Integer amountClassSmall;       // 小班课数量
  
  private Integer amountCash;             // 剩余奖学金
  
  // 四会课 单词
  private Boolean flagPaperTextbookAuth;      // 纸质四会课 权限
  private DateTime expireTimePaperTextbook;   // 纸质四会课 过期时间
  }
  

2. 点击弹窗，上报服务器接口

• URL: {{localhost}}/boxfish-online-card/member/dialog/submitDialog?access_token={{token}}

• Method: POST

• Response: 成功：状态码200

3. 【领取免费课程页面使用】点击领取四会课上报服务器接口

• URL: {{localhost}}/boxfish-online-card/member/textbook/submitTextbookV2?access_token={{token}}
• Method: POST
• Response: 成功：状态码200

4. 【页面使用】学生点击横栏，页面上报学生点击接口

• URL: {{localhost}}/boxfish-online-card/member/banner/userClickBanner?access_token={{token}}
• Method: POST
• RequestBody

{
  "bannerType": "BANNER_TEXTBOOK_V2"
}

bannerType为枚举类型，枚举量为： BANNER_TEXTBOOK_V2：智能四会课横栏，BANNER_CLASS_JHXXQ：精华小学期横栏

• ResponseBody

5. 【APP接口】四会课程书的列表接口

• URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseSummary?access_token=l1RaF90wsf
• Method: POST
• RequestBody

{
    "textbookType":"PAPER_TEXTBOOK_WORD"
}

• ResponseBody

{
    "bookList": [
        {
            "bookId": 226,
            "bookName": "智能同步四会单词课 北京版一年级下",
            "paperNameList": [
                "北京版一年级下U1L1",
                "北京版一年级下U1L2",
                "北京版一年级下U1L3"
            ]
        }
    ]
}

6. 【APP接口】四会课程 课的列表接口

• URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseList?access_token=l1RaF90wsf
• Method: POST
• RequestBody

{
    "bookId": 226,
    "textbookType": "PAPER_TEXTBOOK_WORD"
}

• ResponseBody

7. 【APP接口】四会课程 进课前检查是否有课程权限接口

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

{
    "courseId": "L3NoYXJlL3N2bi_ljJfkuqzniYjlsI_lrabkuIDkuIsgVTEvMTEyLldvcmRzX-WMl-S6rOeJiOS4gOW5tOe6p-S4i1UxTDIueGxzeA"
}

• ResponseBody

{
    "status": "ERROR",
    "type": "COURSE_NOT_TEXTBOOK_WORD",
    "message": "当前课程不是智能四会单词课"
}

学生有权限: status="SUCCESS";
学生没有权限: status="ERROR", type="USER_NO_TEXTBOOK_WORD_AUTH";
课程不是四会单词课: status="ERROR", type="COURSE_NOT_TEXTBOOK_WORD";

8. 【APP接口】basic课程 进课前检查是否有课程权限接口

• URL: {{localhost}}/boxfish-online-card/member/info/checkBasicCourseInfo?access_token={{token}}
• Method: POST
• RequestBody

{
    "courseId": "L3NoYXJlL3N2bi9MZXZlbCAyX0Z1bmN0aW9uMS8wMDEu5aaC5L2V6KGo6L6-4oCc5pep5LiK5aW94oCd77yfLnhsc3g"
}

• ResponseBody

{
    "status": "ERROR",
    "type": "TO_PAY",
    "message": "您没有购买此年级的教材版本。"
}

status = 'SUCCESS'，学生有权限；status = 'ERROR'，没有权限
type = 'type'，没有购买该课程

9. 【APP接口】查询APP领取福利接口，显示高亮信息

• URL: {{localhost}}/boxfish-online-card/member/register/getMemberWelfare?access_token={{token}}
• Method: POST

• RequestBody

• ResponseBody

public static class Response {
    private Boolean flagShowShade;

    private Boolean flagHasClickAdvanced;
    private Boolean flagHasClickBasicTextbookV1Word;
    private Boolean flagHasClickBasicTextbookV2Word;
}

10. 【APP接口】高亮消失上报接口

• URL: {{localhost}}/boxfish-online-card/member/register/clickShade?access_token={{token}}
• Method: POST
• RequestBody
• ResponseBody

11. 【APP接口】点击 "体验课程X" 标签消失接口

• URL: {{localhost}}/boxfish-online-card/member/register/clickShade?access_token={{token}}
• Method: POST
• RequestBody

{
  "type": "BASIC_TEXTBOOK_V1_WORD"
}

"type"为枚举值：
BASIC_TEXTBOOK_V1_WORD
BASIC_TEXTBOOK_V2_WORD
ADVANCED_PAPER_V1_DEMO_V2
INTERNATIONAL_25_MIN_COURSE

• ResponseBody