huayandong

update doc api

... ... @@ -33,7 +33,7 @@
##### 2. 通过邀请码,建立邀请关系
- URL: {{localhost}}/boxfish-online-card/wxUser/addRelationship
- URL: {{localhost}}/boxfish-online-card/wx_mini/addUserRelationship
- Method: POST
- RequestBody:
... ... @@ -62,7 +62,8 @@ public static class Response {
private String targetAvatarUrl;
// 用户当前状态
private Boolean flagUserHasObtain; // 是否领取课程
private Boolean flagUserHasJhxxq; // 是否领取小学期课程
private Boolean flagUserHasObtain; // 是否领取课程 四会单词课
private Long invitationCode; // 已经领取,返回当前用户的邀请码
}
```
... ... @@ -118,7 +119,7 @@ public static class Request {
private String orderMobile; // 收货人手机号
private String orderProvince; // 省
private String orderCity; // 市
private String orderCounty; // 区
private String orderCounty; // 区
private String orderAddressDetail; // 详细地址
private String openId; // 微信openId
... ... @@ -128,7 +129,7 @@ public static class Request {
##### 5. 查询已经领取的教材信息、邀请的用户信息
- URL: {{localhost}}/boxfish-online-card/textbook/obtain/getObtainTextbook
- URL: {{localhost}}/boxfish-online-card/order/textbook/getObtainTextbook
- Method: POST
- RequestBody:
```json
... ... @@ -147,14 +148,20 @@ public static class Response {
// 邀请码
private Long invitationCode;
// 领取的课程信息
// 还可以再领四会单词课的次数
private Integer amountRetainWord;
// 领取的课程信息 四会单词课
private List<TextbookInfo> textbookList = new ArrayList<>();
// 领取的课程信息 小学期
private List<TextbookInfo> textbookList_JHXXQ = new ArrayList<>();
// 邀请的好友信息
private List<WxUserInfo> targetWxUserList = new ArrayList<>();
}
// `textbookList` 信息
public static class TextbookInfo {
private String versionCode;
private String textbookCover;
private String textbookLabel;
}
... ... @@ -165,9 +172,14 @@ public static class WxUserInfo {
private String nickName;
private String avatarUrl;
private Boolean flagPlaceOrder;
private String courseObtainType; // 领取的课程类型,枚举类型
}
```
> `courseObtainType`未枚举类型:<br>
> `COURSE_TEXTBOOK_V2_WORD`:四会单词课
> `COURSE_JHXXQ`:小学期课
##### 6. 缺用户是否已经建立过绑定关系,如果建立过,返回之前绑定关系的邀请码
... ...