huayandong

update doc api

@@ -6,6 +6,67 @@ @@ -6,6 +6,67 @@
6 6
7 - URL: {{localhost}}/boxfish-wudaokou-paper/paper/teacher/paperV1/getPaperSummary?access_token={{access_token}} 7 - URL: {{localhost}}/boxfish-wudaokou-paper/paper/teacher/paperV1/getPaperSummary?access_token={{access_token}}
8 - Method: GET 8 - Method: GET
  9 +- ResponseBody:
  10 +
  11 +```json5
  12 +{
  13 + "status": "SUCCESS",
  14 + "partList": [
  15 + {
  16 + "typeDesc": "进阶单词课",
  17 + "courseTypeV3": "WORD",
  18 + "bookList": [
  19 + {
  20 + "bookId": 323,
  21 + "bookName": "智能单词课 九年级上册1",
  22 + "bookCover": "ddf2629f26d3c2bdcf37f351a8540527",
  23 + "amountCourse": 10,
  24 + "bookOrder": 10910001,
  25 + "paperName": [
  26 + "初中九年级上核心单词1",
  27 + "初中九年级上核心单词2",
  28 + "初中九年级上核心单词3",
  29 + "初中九年级上核心单词4",
  30 + "初中九年级上核心单词5",
  31 + "初中九年级上核心单词6",
  32 + "初中九年级上核心单词7",
  33 + "初中九年级上核心单词8",
  34 + "初中九年级上核心单词9",
  35 + "初中九年级上核心单词10"
  36 + ]
  37 + }
  38 + ]
  39 + },
  40 + {
  41 + "typeDesc": "外教知识点课",
  42 + "courseTypeV3": "KNOWLEDGE",
  43 + "bookList": [
  44 + {
  45 + "bookId": 361,
  46 + "bookName": "智能知识点课九上第一册",
  47 + "bookCover": "0550732752d3b52034c6c363b0c2802c",
  48 + "amountCourse": 12,
  49 + "bookOrder": 10910001,
  50 + "paperName": [
  51 + "句型用法_It's dangerous to do sth. 做某事很危险",
  52 + "如何表达做某事很重要?",
  53 + "如何提醒别忘事儿?",
  54 + "如何提醒某人记得做某事?",
  55 + "如何表达 “系好安全带”?",
  56 + "交通安全,离你有多远?",
  57 + "如何表达惊呆了?",
  58 + "如何表达情不自禁做某事?",
  59 + "如何表示难以置信?",
  60 + "怎样表达后悔做了某事?",
  61 + "如何表达“我恐怕...”?",
  62 + "克服紧张,你有什么绝招?"
  63 + ]
  64 + }
  65 + ]
  66 + }
  67 + ]
  68 +}
  69 +```
9 70
10 71
11 ##### 2. 【中教APP接口】中教老师APP 培优课程页面 查询书中课程列表接口 72 ##### 2. 【中教APP接口】中教老师APP 培优课程页面 查询书中课程列表接口
@@ -17,6 +78,54 @@ @@ -17,6 +78,54 @@
17 78
18 > 参数:班级ID: `bookId` 79 > 参数:班级ID: `bookId`
19 80
  81 +- ResponseBody:
  82 +
  83 +```json5
  84 +{
  85 + "status": "SUCCESS",
  86 + "courseList": [
  87 + {
  88 + "courseId": "L3NoYXJlL3N2bi_liJ3kuK3kuZ3lubTnuqfkuIrmoLjlv4PljZXor40vMDAxLuWIneS4reS5neW5tOe6p-S4iuaguOW_g-WNleivjTEueGxzeA",
  89 + "name": "初中九年级上核心单词1",
  90 + "cover": "76b8a851614d43b059f58eb766265789",
  91 + "orderIndex": 10910001,
  92 + "is_paper": false,
  93 + "paperType": "WORD",
  94 + "nationalKnowledge": [
  95 + "Though...",
  96 + "millions of",
  97 + "in one's opinion"
  98 + ]
  99 + },
  100 + {
  101 + "courseId": "L3NoYXJlL3N2bi_liJ3kuK3kuZ3lubTnuqfkuIrmoLjlv4PljZXor40vMDAyLuWIneS4reS5neW5tOe6p-S4iuaguOW_g-WNleivjTIueGxzeA",
  102 + "name": "初中九年级上核心单词2",
  103 + "cover": "b34315051bd0ddd61ebeaebdedfc4f11",
  104 + "orderIndex": 10910002,
  105 + "is_paper": false,
  106 + "paperType": "WORD",
  107 + "nationalKnowledge": [
  108 + "颜色color:grey/silver",
  109 + "reply to sb.",
  110 + "位置关系:beside/by/below",
  111 + "fall away"
  112 + ]
  113 + },
  114 + {
  115 + "courseId": "L3NoYXJlL3N2bi_liJ3kuK3kuZ3lubTnuqfkuIrmoLjlv4PljZXor40vMDAzLuWIneS4reS5neW5tOe6p-S4iuaguOW_g-WNleivjTMueGxzeA",
  116 + "name": "初中九年级上核心单词3",
  117 + "cover": "e15d895d7c06a355d180501c32ea1c2d",
  118 + "orderIndex": 10910003,
  119 + "is_paper": false,
  120 + "paperType": "WORD",
  121 + "nationalKnowledge": [
  122 + "序数词:fourth/sixth/seventh/eighth/ninth/tenth/twelfth/twentieth",
  123 + "have fun"
  124 + ]
  125 + }
  126 + ]
  127 +}
  128 +```
20 129
21 130
22 > 接口1 和 接口2 在查询三件套课程列表的时候,需要用到老师偏好年级学期的这个字段信息,旧版本中教APP不支持这个字段,需要用最新开放版本中教APP才能使用。 131 > 接口1 和 接口2 在查询三件套课程列表的时候,需要用到老师偏好年级学期的这个字段信息,旧版本中教APP不支持这个字段,需要用最新开放版本中教APP才能使用。
@@ -36,3 +145,75 @@ @@ -36,3 +145,75 @@
36 "paperId": "L3NoYXJlL3N2bi_mmbrog73nn6Xor4bngrnor77lm5vkuIvnrKzkuIDlhowvMDA2LuS6uuexu-WPr-S7peaOp-WItuWkqeawlOWQl--8ny54bHN4" 145 "paperId": "L3NoYXJlL3N2bi_mmbrog73nn6Xor4bngrnor77lm5vkuIvnrKzkuIDlhowvMDA2LuS6uuexu-WPr-S7peaOp-WItuWkqeawlOWQl--8ny54bHN4"
37 } 146 }
38 ``` 147 ```
  148 +
  149 +
  150 +- ResponseBody:
  151 +
  152 +```json5
  153 +{
  154 + "status": "SUCCESS",
  155 + "grades": {
  156 + "A_PLUS": [
  157 + {
  158 + "userId": 100000007983,
  159 + "userName": "柳晓丽",
  160 + "paperScore": 100,
  161 + "paperMark": "A_PLUS"
  162 + }
  163 + ],
  164 + "A": [
  165 + {
  166 + "userId": 100000007964,
  167 + "userName": "tom",
  168 + "paperScore": 97,
  169 + "paperMark": "A"
  170 + }
  171 + ],
  172 + "B": [
  173 + {
  174 + "userId": 100000007962,
  175 + "userName": "lh",
  176 + "paperScore": 80,
  177 + "paperMark": "B"
  178 + }
  179 + ],
  180 + "C": [
  181 + {
  182 + "userId": 100000007832,
  183 + "userName": "梦初",
  184 + "paperScore": 67,
  185 + "paperMark": "C"
  186 + }
  187 + ],
  188 + "D": [
  189 + {
  190 + "userId": 100000007864,
  191 + "userName": "ysss",
  192 + "paperScore": 55,
  193 + "paperMark": "D"
  194 + },
  195 + {
  196 + "userId": 100000007851,
  197 + "userName": "薛磊测试",
  198 + "userAvatars": "https://avatars.boxfish.cn/user/100000007851/figure/1563162265.jpg",
  199 + "paperScore": 50,
  200 + "paperMark": "D"
  201 + }
  202 + ],
  203 + "UN_FINISHED": [
  204 + {
  205 + "userId": 1297128,
  206 + "userName": "何一南",
  207 + "paperScore": -1,
  208 + "paperMark": "UN_FINISHED"
  209 + },
  210 + {
  211 + "userId": 100000004990,
  212 + "userName": "syj",
  213 + "paperScore": -1,
  214 + "paperMark": "UN_FINISHED"
  215 + }
  216 + ]
  217 + }
  218 +}
  219 +```