huayandong

update doc api

@@ -67,43 +67,58 @@ public class MemberSummary implements BeanToJson { @@ -67,43 +67,58 @@ public class MemberSummary implements BeanToJson {
67 ``` 67 ```
68 68
69 69
70 -##### 2. 点击弹窗,上报服务器接口 70 +##### 2. 【APP接口】新注册用户查询领取福利的接口
71 71
72 -- URL: {{localhost}}/boxfish-online-card/member/dialog/submitDialog?access_token={{token}} 72 +- URL: {{localhost}}/boxfish-online-card/member/register/getMemberWelfare?access_token={{token}}
73 - Method: POST 73 - Method: POST
  74 +- RequestBody
  75 +
  76 +- ResponseBody
74 77
75 -- Response: 78 +```java
76 -成功:`状态码200`  
77 79
  80 +```
78 81
79 -##### 3. 【领取免费课程页面使用】点击领取四会课上报服务器接口 82 +##### 3. 【APP接口】新注册用户查询显示"Free已领取"标签的接口
80 83
81 -- URL: {{localhost}}/boxfish-online-card/member/textbook/submitTextbookV2?access_token={{token}} 84 +- URL: {{localhost}}/boxfish-online-card/member/register/getTag?access_token={{token}}
82 - Method: POST 85 - Method: POST
83 -- Response:  
84 -成功:`状态码200`  
85 86
  87 +- ResponseBody
  88 +
  89 +```json5
  90 +{
  91 + "tagTypeList": [
  92 + "BASIC_TEXTBOOK_V1_WORD"
  93 + ]
  94 +}
  95 +
  96 +```
  97 +
  98 +> "tagTypeList"为枚举类型,枚举值为:<br>
  99 +`BASIC_TEXTBOOK_V1_WORD`:智能教材同步学模块<br>
  100 +`BASIC_TEXTBOOK_V2_WORD`:四会单词课模块<br>
86 101
87 102
88 -##### 4. 【页面使用】学生点击横栏,页面上报学生点击接口 103 +##### 4. 【APP接口】点击 "Free已领取" 标签消失接口
89 104
90 -- URL: {{localhost}}/boxfish-online-card/member/banner/userClickBanner?access_token={{token}} 105 +- URL: {{localhost}}/boxfish-online-card/member/register/clickTag?access_token={{token}}
91 - Method: POST 106 - Method: POST
92 - RequestBody 107 - RequestBody
93 108
94 ```json 109 ```json
95 { 110 {
96 - "bannerType": "BANNER_TEXTBOOK_V2" 111 + "type": "BASIC_TEXTBOOK_V1_WORD"
97 } 112 }
98 ``` 113 ```
99 114
100 -> `bannerType`为枚举类型,枚举量为: 115 +> "type"为枚举类型,枚举值为:<br>
101 -> `BANNER_TEXTBOOK_V2`:智能四会课横栏,`BANNER_CLASS_JHXXQ`:精华小学期横栏 116 +`BASIC_TEXTBOOK_V1_WORD`:智能教材同步学模块<br>
  117 +`BASIC_TEXTBOOK_V2_WORD`:四会单词课模块<br>
102 118
103 - ResponseBody 119 - ResponseBody
104 120
105 121
106 -  
107 ##### 5. 【APP接口】四会课程书的列表接口 122 ##### 5. 【APP接口】四会课程书的列表接口
108 123
109 - URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseSummary?access_token=l1RaF90wsf 124 - URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseSummary?access_token=l1RaF90wsf
@@ -204,54 +219,8 @@ public class MemberSummary implements BeanToJson { @@ -204,54 +219,8 @@ public class MemberSummary implements BeanToJson {
204 > type = 'type',没有购买该课程<br> 219 > type = 'type',没有购买该课程<br>
205 220
206 221
207 -##### 9. 【APP接口】查询APP领取福利接口,显示高亮信息  
208 -  
209 -- URL: {{localhost}}/boxfish-online-card/member/register/getMemberWelfare?access_token={{token}}  
210 -- Method: POST  
211 -- RequestBody  
212 -  
213 -- ResponseBody  
214 -  
215 -```java  
216 -public static class Response {  
217 - private Boolean flagShowShade; // 是否显示高亮  
218 -  
219 - private Boolean flagShowTagBasicTextbookV1Word; // 教材同步单词  
220 - private Boolean flagShowTagBasicTextbookV1Knowledge; // 教材同步知识点  
221 - private Boolean flagShowTagBasicTextbookV2Word; // 四会单词  
222 - private Boolean flagShowTagAdvanced; // advanced 1对1外教练习纠正课  
223 -}  
224 -```  
225 -  
226 -  
227 -##### 10. 【弃用接口】 ~~【APP接口】高亮消失上报接口~~  
228 -  
229 -- ~~RL: {{localhost}}/boxfish-online-card/member/register/clickShade?access_token={{token}}~~  
230 -- Method: POST  
231 -- RequestBody  
232 -- ResponseBody  
233 -  
234 -  
235 -##### 11. 【APP接口】点击 "Free已领取" 标签消失接口  
236 -  
237 -- URL: {{localhost}}/boxfish-online-card/member/register/clickTag?access_token={{token}}  
238 -- Method: POST  
239 -- RequestBody  
240 -  
241 -```json  
242 -{  
243 - "type": "BASIC_TEXTBOOK_V1_WORD"  
244 -}  
245 -```  
246 -  
247 -> "type"为枚举类型,枚举值为:<br>  
248 -`BASIC_TEXTBOOK_V1_WORD`:智能教材同步学模块<br>  
249 -`BASIC_TEXTBOOK_V2_WORD`:四会单词课模块<br>  
250 -  
251 -- ResponseBody  
252 -  
253 222
254 -##### 12. 【页面接口 for 旺旺】学生在网页领取福利接口 223 +##### 9. 【页面接口 for 旺旺】学生在网页领取福利接口
255 224
256 - URL: {{localhost}}/boxfish-online-card/member/register/submitWelfareType?access_token={{token}} 225 - URL: {{localhost}}/boxfish-online-card/member/register/submitWelfareType?access_token={{token}}
257 - Method: POST 226 - Method: POST