huayandong

update doc api

... ... @@ -67,43 +67,58 @@ public class MemberSummary implements BeanToJson {
```
##### 2. 点击弹窗,上报服务器接口
##### 2. 【APP接口】新注册用户查询领取福利的接口
- URL: {{localhost}}/boxfish-online-card/member/dialog/submitDialog?access_token={{token}}
- URL: {{localhost}}/boxfish-online-card/member/register/getMemberWelfare?access_token={{token}}
- Method: POST
- RequestBody
- ResponseBody
- Response:
成功:`状态码200`
```java
```
##### 3. 【领取免费课程页面使用】点击领取四会课上报服务器接口
##### 3. 【APP接口】新注册用户查询显示"Free已领取"标签的接口
- URL: {{localhost}}/boxfish-online-card/member/textbook/submitTextbookV2?access_token={{token}}
- URL: {{localhost}}/boxfish-online-card/member/register/getTag?access_token={{token}}
- Method: POST
- Response:
成功:`状态码200`
- ResponseBody
```json5
{
"tagTypeList": [
"BASIC_TEXTBOOK_V1_WORD"
]
}
```
> "tagTypeList"为枚举类型,枚举值为:<br>
`BASIC_TEXTBOOK_V1_WORD`:智能教材同步学模块<br>
`BASIC_TEXTBOOK_V2_WORD`:四会单词课模块<br>
##### 4. 【页面使用】学生点击横栏,页面上报学生点击接口
- URL: {{localhost}}/boxfish-online-card/member/banner/userClickBanner?access_token={{token}}
##### 4. 【APP接口】点击 "Free已领取" 标签消失接口
- URL: {{localhost}}/boxfish-online-card/member/register/clickTag?access_token={{token}}
- Method: POST
- RequestBody
```json
{
"bannerType": "BANNER_TEXTBOOK_V2"
"type": "BASIC_TEXTBOOK_V1_WORD"
}
```
> `bannerType`为枚举类型,枚举量为:
> `BANNER_TEXTBOOK_V2`:智能四会课横栏,`BANNER_CLASS_JHXXQ`:精华小学期横栏
> "type"为枚举类型,枚举值为:<br>
`BASIC_TEXTBOOK_V1_WORD`:智能教材同步学模块<br>
`BASIC_TEXTBOOK_V2_WORD`:四会单词课模块<br>
- ResponseBody
##### 5. 【APP接口】四会课程书的列表接口
- URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseSummary?access_token=l1RaF90wsf
... ... @@ -204,54 +219,8 @@ public class MemberSummary implements BeanToJson {
> type = 'type',没有购买该课程<br>
##### 9. 【APP接口】查询APP领取福利接口,显示高亮信息
- URL: {{localhost}}/boxfish-online-card/member/register/getMemberWelfare?access_token={{token}}
- Method: POST
- RequestBody
- ResponseBody
```java
public static class Response {
private Boolean flagShowShade; // 是否显示高亮
private Boolean flagShowTagBasicTextbookV1Word; // 教材同步单词
private Boolean flagShowTagBasicTextbookV1Knowledge; // 教材同步知识点
private Boolean flagShowTagBasicTextbookV2Word; // 四会单词
private Boolean flagShowTagAdvanced; // advanced 1对1外教练习纠正课
}
```
##### 10. 【弃用接口】 ~~【APP接口】高亮消失上报接口~~
- ~~RL: {{localhost}}/boxfish-online-card/member/register/clickShade?access_token={{token}}~~
- Method: POST
- RequestBody
- ResponseBody
##### 11. 【APP接口】点击 "Free已领取" 标签消失接口
- URL: {{localhost}}/boxfish-online-card/member/register/clickTag?access_token={{token}}
- Method: POST
- RequestBody
```json
{
"type": "BASIC_TEXTBOOK_V1_WORD"
}
```
> "type"为枚举类型,枚举值为:<br>
`BASIC_TEXTBOOK_V1_WORD`:智能教材同步学模块<br>
`BASIC_TEXTBOOK_V2_WORD`:四会单词课模块<br>
- ResponseBody
##### 12. 【页面接口 for 旺旺】学生在网页领取福利接口
##### 9. 【页面接口 for 旺旺】学生在网页领取福利接口
- URL: {{localhost}}/boxfish-online-card/member/register/submitWelfareType?access_token={{token}}
- Method: POST
... ...