huayandong / recommend-api

Go to a project
Toggle navigation Toggle navigation pinning
Switch branch/tag
20190911-中教APP.md 9.98 KB

996.icu

1. 【中教APP接口】中教老师APP 培优课程页面 查询三件套接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/teacher/paperV1/getPaperSummary?access_token={{access_token}}
  • Method: GET
  • RequestParam:
请求参数 类型 必填 说明
access_token String Y 接口请求凭证
  • ResponseBody:
变量名 类型 说明
status String 接口请求状态标识：status = SUCCESS请求成功，status = ERROR请求失败
message String status = ERROR时的异常描述信息，status = SUCCESS时该字段为空
partList Array.<Object> 培优课三个模块的返回体，三件套单词、三件套知识点、三件套阅读
  • partList的结构
变量名 类型 说明
courseTypeV3 String 培优课模块类型，可能值有：WORD，KNOWLEDGE，READING
typeDesc String 培优课模块类型的中文描述，可能值有：进阶单词课，外教知识点课，阅读思维课
bookList Array.<Object> 当前培优课模块下全部的书，服务器已按照书的排序序号排好序，如果当前培优课下没有书，该数组为空
  • bookList的结构
变量名 类型 说明
bookId Integer 当前书的id，唯一标识
bookName String 当前书的名称
bookCover String 当前书的封面，图片的MD5值
amountCourse Integer 书中课程的数量
bookOrder Integer 书的排序序号
paperName Array.<String> 当前书中全部课程的名称，服务器已按照课程的顺序排好序
  • 返回数据示例
{
  "status": "SUCCESS",
  "partList": [
    {
      "typeDesc": "进阶单词课",
      "courseTypeV3": "WORD",
      "bookList": [
        {
          "bookId": 323,
          "bookName": "智能单词课 九年级上册1",
          "bookCover": "ddf2629f26d3c2bdcf37f351a8540527",
          "amountCourse": 10,
          "bookOrder": 10910001,
          "paperName": [
            "初中九年级上核心单词1",
            "初中九年级上核心单词2",
            "初中九年级上核心单词3",
            "初中九年级上核心单词4",
            "初中九年级上核心单词5",
            "初中九年级上核心单词6",
            "初中九年级上核心单词7",
            "初中九年级上核心单词8",
            "初中九年级上核心单词9",
            "初中九年级上核心单词10"
          ]
        }
      ]
    },
    {
      "typeDesc": "外教知识点课",
      "courseTypeV3": "KNOWLEDGE",
      "bookList": [
        {
          "bookId": 361,
          "bookName": "智能知识点课九上第一册",
          "bookCover": "0550732752d3b52034c6c363b0c2802c",
          "amountCourse": 12,
          "bookOrder": 10910001,
          "paperName": [
            "句型用法_It's dangerous to do sth. 做某事很危险",
            "如何表达做某事很重要？",
            "如何提醒别忘事儿？",
            "如何提醒某人记得做某事？",
            "如何表达 “系好安全带”？",
            "交通安全，离你有多远？",
            "如何表达惊呆了？",
            "如何表达情不自禁做某事？",
            "如何表示难以置信？",
            "怎样表达后悔做了某事？",
            "如何表达“我恐怕...”？",
            "克服紧张，你有什么绝招？"
          ]
        }
      ]
    }
  ]
}
2. 【中教APP接口】中教老师APP 培优课程页面 查询书中课程列表接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/teacher/paperV1/getCourseList?access_token=C79UqJV93Z&bookId=264
  • Method: GET
  • RequestParam:
请求参数 类型 必填 说明
access_token String Y 接口请求凭证
bookId Integer Y 书的id，唯一标识
  • ResponseBody:
变量名 类型 说明
status String 接口请求状态标识：status = SUCCESS请求成功，status = ERROR请求失败
message String status = ERROR时的异常描述信息，status = SUCCESS时该字段为空
courseList Array.<Object> 课程信息
  • courseList的结构
变量名 类型 说明
paperId String 课程的纸质课程ID，如果该课程是不是真的三件套课程，则该字段为空
courseId String 该课程APP课程的ID，不管是真三件套还是假三件套，该字段一定不为空
name String 课程名称
cover String 课程封面，MD5值
orderIndex Integer 课程的排序顺序
student boolean 该课程是否有学生版
teacher boolean 该课程是否有老师版
is_paper boolean 该是否为真三件套，is_paper = true课程是真三件套，is_paper = false课程是假三件套
paperType String 课程的类型，可能有的值为：WORD，KNOWLEDGE，READING
nationalKnowledge Array.<String> 课程的教材大纲知识点
  • 返回数据示例
{
  "status": "SUCCESS",
  "courseList": [
    {
      "courseId": "L3NoYXJlL3N2bi_liJ3kuK3kuZ3lubTnuqfkuIrmoLjlv4PljZXor40vMDAxLuWIneS4reS5neW5tOe6p-S4iuaguOW_g-WNleivjTEueGxzeA",
      "name": "初中九年级上核心单词1",
      "cover": "76b8a851614d43b059f58eb766265789",
      "orderIndex": 10910001,
      "is_paper": false,
      "paperType": "WORD",
      "nationalKnowledge": [
        "Though...",
        "millions of",
        "in one's opinion"
      ]
    },
    {
      "courseId": "L3NoYXJlL3N2bi_liJ3kuK3kuZ3lubTnuqfkuIrmoLjlv4PljZXor40vMDAyLuWIneS4reS5neW5tOe6p-S4iuaguOW_g-WNleivjTIueGxzeA",
      "name": "初中九年级上核心单词2",
      "cover": "b34315051bd0ddd61ebeaebdedfc4f11",
      "orderIndex": 10910002,
      "is_paper": false,
      "paperType": "WORD",
      "nationalKnowledge": [
        "颜色color:grey/silver",
        "reply to sb.",
        "位置关系:beside/by/below",
        "fall away"
      ]
    },
    {
      "courseId": "L3NoYXJlL3N2bi_liJ3kuK3kuZ3lubTnuqfkuIrmoLjlv4PljZXor40vMDAzLuWIneS4reS5neW5tOe6p-S4iuaguOW_g-WNleivjTMueGxzeA",
      "name": "初中九年级上核心单词3",
      "cover": "e15d895d7c06a355d180501c32ea1c2d",
      "orderIndex": 10910003,
      "is_paper": false,
      "paperType": "WORD",
      "nationalKnowledge": [
        "序数词：fourth/sixth/seventh/eighth/ninth/tenth/twelfth/twentieth",
        "have fun"
      ]
    }
  ]
}
3. 【中教APP接口】中教老师APP 课程首页2页面 查询班级学生同步测验课程完成成绩
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/teacher/group/getCourseGrade?access_token=xu7NU3O3NY
  • Method: POST

  • RequestBody:

  • 请求体结构

请求参数 类型 必填 说明
groupId Integer Y 班级ID
paperId String Y 纸质课程ID
  • 请求体数据示例
{
    "groupId": 31213,
    "paperId": "L3NoYXJlL3N2bi_mmbrog73nn6Xor4bngrnor77lm5vkuIvnrKzkuIDlhowvMDA2LuS6uuexu-WPr-S7peaOp-WItuWkqeawlOWQl--8ny54bHN4"
}

  • ResponseBody:

  • 返回体结构

变量名 类型 说明
status String 接口请求状态标识：status = SUCCESS请求成功，status = ERROR请求失败
message String status = ERROR时的异常描述信息，status = SUCCESS时该字段为空
grades Map.<String, Object> 1. map的key是纸质成绩的的等级，如果该等级没有学生，则map中不会出现该等级；
2. map的value是每个等级成绩下的学生信息；
3. 服务器已按照map的key排序，排序顺序为：A_PLUS、A、B、C、D、UN_FINISHED
  • grades map的value的结构
变量名 类型 说明
userId Integer 学生ID
userName String 学生名称，服务器优先显示：真实姓名、昵称、用户名，具体显示逻辑见产品文档，中教产品文档：课程首页1-用户姓名显示优先级
userAvatars String 学生头像，字符串类型，不是MD5
paperScore Integer 纸质课程识别的分数， 为了方便服务器排序，服务器会将 UN_FINISHED学生的分数设置为-1分，即paperScore = -1，APP端显示的时候需要注意这种情况
paperMark String 纸质课程成绩等级，根据纸质识别分数计算得到，计算规则见产品文档，中教产品文档：课程首页2-成绩计算方式
  • 返回体数据示例
{
  "status": "SUCCESS",
  "grades": {
    "A_PLUS": [
      {
        "userId": 100000007983,
        "userName": "柳晓丽",
        "paperScore": 100,
        "paperMark": "A_PLUS"
      }
    ],
    "A": [
      {
        "userId": 100000007964,
        "userName": "tom",
        "paperScore": 97,
        "paperMark": "A"
      }
    ],
    "B": [
      {
        "userId": 100000007962,
        "userName": "lh",
        "paperScore": 80,
        "paperMark": "B"
      }
    ],
    "C": [
      {
        "userId": 100000007832,
        "userName": "梦初",
        "paperScore": 67,
        "paperMark": "C"
      }
    ],
    "D": [
      {
        "userId": 100000007864,
        "userName": "ysss",
        "paperScore": 55,
        "paperMark": "D"
      },
      {
        "userId": 100000007851,
        "userName": "薛磊测试",
        "userAvatars": "https://avatars.boxfish.cn/user/100000007851/figure/1563162265.jpg",
        "paperScore": 50,
        "paperMark": "D"
      }
    ],
    "UN_FINISHED": [
      {
        "userId": 1297128,
        "userName": "何一南",
        "paperScore": -1,
        "paperMark": "UN_FINISHED"
      },
      {
        "userId": 100000004990,
        "userName": "syj",
        "paperScore": -1,
        "paperMark": "UN_FINISHED"
      }
    ]
  }
}