huayandong

doc api

@@ -67,11 +67,77 @@ public static class Response { @@ -67,11 +67,77 @@ public static class Response {
67 } 67 }
68 ``` 68 ```
69 69
70 -  
71 -  
72 -  
73 ##### 3. 微信用户获取全部的教材版本、年级信息 70 ##### 3. 微信用户获取全部的教材版本、年级信息
74 71
75 - URL: {{localhost}}/boxfish-online-card/textbook/version/getTextbookGrade 72 - URL: {{localhost}}/boxfish-online-card/textbook/version/getTextbookGrade
76 - Method: GET 73 - Method: GET
  74 +- RequestBody: `json字符串`
  75 +
  76 +
  77 +
  78 +##### 4. 用户提交教材版本、手机号、地址信息
  79 +
  80 +- URL: {{localhost}}/boxfish-online-card/textbook/version/submitTextbookVersion
  81 +- Method: POST
77 - RequestBody: 82 - RequestBody:
  83 +
  84 +```java
  85 +public static class Request {
  86 + private String mobile;
  87 + private String address;
  88 + private String versionCode;
  89 +
  90 + private String openId;
  91 + private Long invitationCode;
  92 +}
  93 +```
  94 +
  95 +- ResponseBody:
  96 +
  97 +```java
  98 +public static class Response {
  99 + // status
  100 + private ResponseStatus status;
  101 + private String message;
  102 +
  103 + private Long invitationCode;
  104 +}
  105 +```
  106 +
  107 +##### 5. 查询已经领取的教材信息、邀请的用户信息
  108 +
  109 +- URL: {{localhost}}/boxfish-online-card/textbook/obtain/getObtainTextbook?openId=${{openId}}
  110 +- Method: GET
  111 +- Requestparam: `openId`
  112 +
  113 +- ResponseBody:
  114 +
  115 +```java
  116 +public static class Response {
  117 + // status
  118 + private ResponseStatus status;
  119 + private String message;
  120 +
  121 + // 领取的课程信息
  122 + private List<TextbookInfo> textbookList = new ArrayList<>();
  123 + // 邀请的好友信息
  124 + private List<WxUserInfo> targetWxUserList = new ArrayList<>();
  125 +}
  126 +
  127 +// `textbookList` 信息
  128 +public static class TextbookInfo {
  129 + private String textbookCover;
  130 + private String textbookLabel;
  131 +}
  132 +
  133 +// `targetWxUserList` 信息
  134 +public static class WxUserInfo {
  135 + private String openId;
  136 + private String nickName;
  137 + private String avatarUrl;
  138 + private Boolean flagPlaceOrder;
  139 +}
  140 +
  141 +
  142 +```
  143 +