huayandong / recommend-api

Go to a project
Toggle navigation Toggle navigation pinning
Switch branch/tag
13.3.0.md 6.71 KB

996.icu

13.0接口

1. 【APP接口】查询今日课表和未来一天课表接口
  • URL: {{localhost}}/boxfish-online-card/classOpen/student/getScheduleAssembleV2ByStudentId?access_token={{token}}
  • Method: GET
  • ResponseBody:
{
  "systemTime": 1561623470792,
  "classSchedule_TODAY": {},      // 今日课表
  "classSchedule_FUTURE": {},     // 近日课表 显示的课程信息
  "flagNeedSchedule": true,       // 是否需要显示 "预约课程" 标识
  "scheduleFuture_topic": "xxx"   // 近日课表没有课的时候，显示的文案
}

今日课表显示规则：

当课程类型是"Alex大班课"的时候，即classType = "CLASS_ONLINE_US_010N"时，卡片上显示的文案以classTypeDescriptionV1的内容为准

2. 【APP接口】查询未完成课表接口
  • URL: {{localhost}}/boxfish-online-card/member/schedule/getFutureSchedule?access_token=BsVNIqxWu8
  • Method: GET
3. 【APP接口】查询已完成课表
  • URL: {{localhost}}/boxfish-online-card/member/schedule/getHistorySchedule?access_token=BsVNIqxWu8
  • Method: GET

学生没有上课的状态："classStatus": "DEBUG_STUDENT_ABSENT"

4. 【APP接口】三件套APP课程列表 和 四会课课程列表 返回数据中增加纸质作业完成状态，和三件套的类型

接口URL：{{localhost}}/boxfish-online-card/member/info/getPaperV1BookDetail
和 {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseList

5. 上课课程类型 及 名称
// 公开课 中教
CLASS_OPEN_CN,
// 公开课 外教
CLASS_OPEN_US,
// 公开课 大师
CLASS_OPEN_MASTER,
// 公开课 推广
CLASS_OPEN_PROMOTION,

// 班课 中教 1对多
CLASS_SMALL_CN,
// 班课 外教 1对多
CLASS_SMALL_US,

// 班课 外教 1对1
CLASS_ONLINE_US_0101,
// Alex大班课
CLASS_ONLINE_US_010N；
6. 【APP接口，在原有接口的返回体中增加错误类型】三件套 APP课程列表 点击进课接口调的接口增加返回类型
  • URL: /member/info/checkPaperV1Info
  • ResponseBody:

校验通过

{
  "status": "SUCCESS",
  "message": "权限校验成功"
}

校验不通过：没有购买

{
  "status": "ERROR",
  "type":"TO_PAY",
  "message": "本课是创新培优系列课程，现在购买就可以开始学习啦~"
}

校验不通过：学生选的偏好没有购买三件套

{
  "status": "ERROR",
  "type":"PREFERENCE_ERROR",
  "message": "您购买的`四会英语课`在四年级上学期，切换到对应的年级即可学习。"
}

校验不通过：课程延迟开放，此类型为新增错误类型。

{
  "status": "ERROR",
  "type":"TO_WAIT",
  "message": "课程紧急制作中，敬请期待~"
}
7. 【APP接口，在原有接口的返回体增加标签类型】APP查询领取礼包类型接口
  • URL: /member/register/getTag
  • ResponseBody:
{
  "tagTypeList": [
    "BASIC_TEXTBOOK_V1_WORD",    // 领取教材同步单词
    "BASIC_TEXTBOOK_V2_WORD",    // 领取四会单词

    "ADVANCED_PAPER_V1_DEMO_V2"  // 领取精华小学期礼包，这个标签是新增加返回的
  ]
}
8. 【APP接口，在原有接口的返回体中增加资源数据】未购买用户首页banner位置显示图片 和 网页
  • URL: {{localhost}}/boxfish-wudaokou-user/ticket/BOXFISH_RESOURCE_IMAGE?access_token=Bb6HtBFHDw
  • Method: GET -ResponseBody:
{
    "advanced_banner_image_pad": "https://avatars.boxfish.cn/app_resources/harvard_page_image_ipad.png",
    "index_advertisement_url": "https://www.boxfish.cn/share/market/sihui.html",
    "index_advertisement_phone": "https://avatars.boxfish.cn/app_resources/index_advertisement_iphone_0702.png",
    "advanced_banner_image_phone": "https://avatars.boxfish.cn/app_resources/harvard_page_image_ihone.png",
    "advanced_banner_image_url": "https://www.boxfish.cn/share/market/harvard.html",
    "index_advertisement_pad": "https://avatars.boxfish.cn/app_resources/index_advertisement_ipad_0702.png",
    "advanced_index_image_phone": "https://avatars.boxfish.cn/app_resources/index_top_image_iphone_0614.png",
    "advanced_index_image_pad": "https://avatars.boxfish.cn/app_resources/index_top_image_ipad_0614.png",

    // 首页未购买用户banner位置 显示图片和购买链接，20190703
    "index_unPurchase_banner_url": "https://www.boxfish.cn/share/market/harvard.html",
    "index_unPurchase_banner_image_pad": "https://avatars.boxfish.cn/app_resources/harvard_page_image_ipad.png"
    "index_unPurchase_banner_image_phone": "https://avatars.boxfish.cn/app_resources/harvard_page_image_ihone.png",
}
9. 【APP接口，在原有接口的返回体中增加资源数据】getMemberInfo接口增加字段，标识学生是否购买advanced相关的课程
  • URL: {{localhost}}/boxfish-online-card/member/info/getMemberInfo?access_token=Bb6HtBFHDw
  • Method: GET -ResponseBody:
{
    "userId": 100000006030,
    "memberType": "MEMBER_OLD_PAID",
    "expireTimeMember": 1650297600000,
    "memberTypeV2": "MEMBER_V2_OLD",
    "amountClassSvValid": 97,
    "amountClassSvFinished": 20,
    "expireTimeClassSv": 1600444799000,
    "amountClassSv10Valid": 336,
    "expireDescClassSv5": "4课将于7月4日到期",
    "expireDescClassSv10": "336课将于7月13日到期",
    "amountExamOral": 28,
    "expireTimeExamOral": 1656259200000,
    "amountOpenUs": 370,
    "expireTimeOpenUs": 1574956800000,
    "flagPaperV1Auth": true,
    "expireTimePaperV1": 1684079999999,
    "classSmallId": 50,
    "classSmallName": "alex大班",
    "flagJhxxqAuth": true,
    "expireTimeJhxxq": 1572105599999,
    "flagUserIsPaid": true,
    "flagUserIsPaid_advanced": true,
    "flagPaperTextbookAuth": true,
    "expireTimePaperTextbook": 1684079999999
}

flagUserIsPaid_advanced = true，用户购买过advanced相关课程，flagUserIsPaid_advanced = false，用户没有购买过advanced课程。

10. 【APP接口】APP首页 获取显示礼包网页的接口
  • URL: {{localhost}}/boxfish-online-card/member/welfare/getWelfareType?access_token={{token}}
  • Method: POST -ResponseBody:
{
  "flagShowWelfarePage": true,
  "welfareUrl": "https://www.boxfish.cn/share/market/sihui.html?type=BASIC_ADVANCED"
}
11. 【网页接口 for 旺旺】显示礼包页面，点击 "开学免费拿走" 按钮出发的上报接口
  • URL: {{localhost}}/boxfish-online-card/member/welfare/clickWelfarePackage?access_token=3uWeawnWVy
  • Method: POST
12. 【APP接口，之前就存在的接口】教材同步课程课程列表页面，点击课程，进行权限校验的接口
  • URL: {{localhost}}/boxfish-online-card/member/info/checkBasicCourseInfo?access_token=hX5mUCPbxo