huayandong

doc api

... ... @@ -67,11 +67,77 @@ public static class Response {
}
```
##### 3. 微信用户获取全部的教材版本、年级信息
- URL: {{localhost}}/boxfish-online-card/textbook/version/getTextbookGrade
- Method: GET
- RequestBody: `json字符串`
##### 4. 用户提交教材版本、手机号、地址信息
- URL: {{localhost}}/boxfish-online-card/textbook/version/submitTextbookVersion
- Method: POST
- RequestBody:
```java
public static class Request {
private String mobile;
private String address;
private String versionCode;
private String openId;
private Long invitationCode;
}
```
- ResponseBody:
```java
public static class Response {
// status
private ResponseStatus status;
private String message;
private Long invitationCode;
}
```
##### 5. 查询已经领取的教材信息、邀请的用户信息
- URL: {{localhost}}/boxfish-online-card/textbook/obtain/getObtainTextbook?openId=${{openId}}
- Method: GET
- Requestparam: `openId`
- ResponseBody:
```java
public static class Response {
// status
private ResponseStatus status;
private String message;
// 领取的课程信息
private List<TextbookInfo> textbookList = new ArrayList<>();
// 邀请的好友信息
private List<WxUserInfo> targetWxUserList = new ArrayList<>();
}
// `textbookList` 信息
public static class TextbookInfo {
private String textbookCover;
private String textbookLabel;
}
// `targetWxUserList` 信息
public static class WxUserInfo {
private String openId;
private String nickName;
private String avatarUrl;
private Boolean flagPlaceOrder;
}
```
... ...