huayandong

update doc api

@@ -33,7 +33,7 @@ @@ -33,7 +33,7 @@
33 33
34 ##### 2. 通过邀请码,建立邀请关系 34 ##### 2. 通过邀请码,建立邀请关系
35 35
36 -- URL: {{localhost}}/boxfish-online-card/wxUser/addRelationship 36 +- URL: {{localhost}}/boxfish-online-card/wx_mini/addUserRelationship
37 - Method: POST 37 - Method: POST
38 - RequestBody: 38 - RequestBody:
39 39
@@ -62,7 +62,8 @@ public static class Response { @@ -62,7 +62,8 @@ public static class Response {
62 private String targetAvatarUrl; 62 private String targetAvatarUrl;
63 63
64 // 用户当前状态 64 // 用户当前状态
65 - private Boolean flagUserHasObtain; // 是否领取课程 65 + private Boolean flagUserHasJhxxq; // 是否领取小学期课程
  66 + private Boolean flagUserHasObtain; // 是否领取课程 四会单词课
66 private Long invitationCode; // 已经领取,返回当前用户的邀请码 67 private Long invitationCode; // 已经领取,返回当前用户的邀请码
67 } 68 }
68 ``` 69 ```
@@ -118,7 +119,7 @@ public static class Request { @@ -118,7 +119,7 @@ public static class Request {
118 private String orderMobile; // 收货人手机号 119 private String orderMobile; // 收货人手机号
119 private String orderProvince; // 省 120 private String orderProvince; // 省
120 private String orderCity; // 市 121 private String orderCity; // 市
121 - private String orderCounty; // 区 122 + private String orderCounty; // 区
122 private String orderAddressDetail; // 详细地址 123 private String orderAddressDetail; // 详细地址
123 124
124 private String openId; // 微信openId 125 private String openId; // 微信openId
@@ -128,7 +129,7 @@ public static class Request { @@ -128,7 +129,7 @@ public static class Request {
128 129
129 ##### 5. 查询已经领取的教材信息、邀请的用户信息 130 ##### 5. 查询已经领取的教材信息、邀请的用户信息
130 131
131 -- URL: {{localhost}}/boxfish-online-card/textbook/obtain/getObtainTextbook 132 +- URL: {{localhost}}/boxfish-online-card/order/textbook/getObtainTextbook
132 - Method: POST 133 - Method: POST
133 - RequestBody: 134 - RequestBody:
134 ```json 135 ```json
@@ -147,14 +148,20 @@ public static class Response { @@ -147,14 +148,20 @@ public static class Response {
147 148
148 // 邀请码 149 // 邀请码
149 private Long invitationCode; 150 private Long invitationCode;
150 - // 领取的课程信息 151 +
  152 + // 还可以再领四会单词课的次数
  153 + private Integer amountRetainWord;
  154 + // 领取的课程信息 四会单词课
151 private List<TextbookInfo> textbookList = new ArrayList<>(); 155 private List<TextbookInfo> textbookList = new ArrayList<>();
  156 + // 领取的课程信息 小学期
  157 + private List<TextbookInfo> textbookList_JHXXQ = new ArrayList<>();
152 // 邀请的好友信息 158 // 邀请的好友信息
153 private List<WxUserInfo> targetWxUserList = new ArrayList<>(); 159 private List<WxUserInfo> targetWxUserList = new ArrayList<>();
154 } 160 }
155 161
156 // `textbookList` 信息 162 // `textbookList` 信息
157 public static class TextbookInfo { 163 public static class TextbookInfo {
  164 + private String versionCode;
158 private String textbookCover; 165 private String textbookCover;
159 private String textbookLabel; 166 private String textbookLabel;
160 } 167 }
@@ -165,9 +172,14 @@ public static class WxUserInfo { @@ -165,9 +172,14 @@ public static class WxUserInfo {
165 private String nickName; 172 private String nickName;
166 private String avatarUrl; 173 private String avatarUrl;
167 private Boolean flagPlaceOrder; 174 private Boolean flagPlaceOrder;
  175 + private String courseObtainType; // 领取的课程类型,枚举类型
168 } 176 }
169 ``` 177 ```
170 178
  179 +> `courseObtainType`未枚举类型:<br>
  180 +> `COURSE_TEXTBOOK_V2_WORD`:四会单词课
  181 +> `COURSE_JHXXQ`:小学期课
  182 +
171 183
172 ##### 6. 缺用户是否已经建立过绑定关系,如果建立过,返回之前绑定关系的邀请码 184 ##### 6. 缺用户是否已经建立过绑定关系,如果建立过,返回之前绑定关系的邀请码
173 185