梁海波

Updated 退回群红包 (markdown)

@@ -5,20 +5,78 @@ @@ -5,20 +5,78 @@
5 #### 接口说明 5 #### 接口说明
6 6
7 + 请求地址 7 + 请求地址
8 -`/api/teacher/has_red_envelopes` 8 +`/api/tc/big/red_envelope/back`
9 + 请求方式 9 + 请求方式
10 `POST` 10 `POST`
11 11
  12 ++ 请求示例
  13 +
  14 +http://localhost:9107/api/tc/big/red_envelope/back?size=2&page=0
  15 +
  16 +body:
  17 +
  18 +```json
  19 +{
  20 +"relId":119,
  21 +"sum":"10123"
  22 +}
  23 +```
  24 +
12 + 请求参数 25 + 请求参数
13 26
14 | 参数 | 说明 | 必选? | 27 | 参数 | 说明 | 必选? |
15 | ---- | ---- | ---- | 28 | ---- | ---- | ---- |
16 -| sum | 红包金额,单位分,整数,不能为空 | 是 | 29 +| sum | 红包金额,单位分,整数,不能为空,请求body | 是 |
17 -| relId | 群红包的id,整数,不能为空 | 是 | 30 +| relId | 群红包的id,整数,不能为空,请求body | 是 |
  31 +| page | 页码,0开始,默认是0,请求参数 | 否 |
  32 +| size | 每页数量,默认是20,请求参数 | 否 |
18 33
19 -+ 返回保存后的数据 34 ++ 返回数据
20 ```json 35 ```json
21 { 36 {
22 - 37 + "limitSum": 140000, -- 限额
  38 + "remain": 130657, -- 余额
  39 + "logs": { -- 流水日志
  40 + "content": [
  41 + {
  42 + "id": 119, -- id,退回红包时需要传的id
  43 + "time": "2016-11-16 18:37:31", -- 时间
  44 + "name": "qun'fa群发ce'sh群发测试 hong'bao红包 ", -- 群红包描述
  45 + "sum": 10000, -- 金额,单位分
  46 + "backs": [ -- 退回红包记录,可能有多次,所以是列表
  47 + {
  48 + "id": 121,
  49 + "time": "2016-11-17 09:36:14", -- 退回时间
  50 + "name": "退回", -- 名字一律都是叫“退回”
  51 + "sum": 10123, -- 退回金额,单位分
  52 + "backs": null
  53 + }
  54 + ]
  55 + },
  56 + {
  57 + "id": 118,
  58 + "time": "2016-11-16 18:37:27",
  59 + "name": "qun'fa群发ce'sh群发测试 hong'bao红包 ",
  60 + "sum": 10000,
  61 + "backs": []
  62 + }
  63 + ],
  64 + "last": false, -- true是最后一页;false不是最后一页
  65 + "totalElements": 22, -- 总记录数
  66 + "totalPages": 11, -- 总页数
  67 + "size": 2, -- 每页记录数
  68 + "number": 0, -- 页码,从0开始
  69 + "sort": [
  70 + {
  71 + "direction": "DESC",
  72 + "property": "createAt",
  73 + "ignoreCase": false,
  74 + "nullHandling": "NATIVE",
  75 + "ascending": false
  76 + }
  77 + ],
  78 + "first": true,
  79 + "numberOfElements": 2 -- 当前页实际记录数
  80 + }
23 } 81 }
24 ``` 82 ```