Authored by caoyan

Add limitCode.md

  1 +# 限购码管理接口服务定义
  2 +---------------------
  3 +
  4 +# 添加限购码接口
  5 +
  6 +> 接口名: `/limitCode/addLimitCode`
  7 +
  8 +### 入参
  9 +
  10 +-------------------------
  11 +|属性名称|类型|例子|说明|是否必填|
  12 +|--------|----|----|----|--------|
  13 +|name|string|潮流尖货限购码|限购码名称|是|
  14 +|limitTimes|int|100|数量|是|
  15 +|reqDepartment|string|运营部|申请部门|否|
  16 +|limitDateFrom|string|2016-02-01 14:00:00|起始时间|是|
  17 +|limitDateTo|string|2016-02-20 14:00:00|失效时间|是|
  18 +|describe|string|耐克新款|限购码描述|否|
  19 +|userUseLimit|int|1|用户使用次数|否|
  20 +|userTypeLimit|int|1|用户类型|否
  21 +|limitSkn|string|50012345|限购商品skn|否
  22 +|creatorName|string|张三|创建者名称|否
  23 +|creatorId|int|12401|创建者ID|否
  24 +|createTime|string|2016-01-29 15:00:00|创建时间|否
  25 +|status|int|0|限购码状态0:待审核 1:审核通过 2:驳回 3:过期 4:作废|否
  26 +|reason|string|预算不够|驳回原因|否
  27 +|batchNo|string|201602021023|批次号|是
  28 +|auditTime|string|2016-01-30 15:00:00|审核时间|否
  29 +---------------------
  30 +
  31 +### 返回
  32 +
  33 +``` json
  34 +{
  35 + "code": 200,
  36 + "data": [],
  37 + "md5": "d751713988987e9331980363e24189ce",
  38 + "message": "addLimitCode success."
  39 +}
  40 +
  41 +```
  42 +
  43 +# 获取限购码列表
  44 +
  45 +> 接口名: `/limitCode/getLimitCodeList`
  46 +
  47 +### 入参
  48 +
  49 +-------------------------
  50 +|属性名称|类型|例子|说明|是否必填|
  51 +|-------|----|----|----|-------|
  52 +--------------------------------
  53 +
  54 +### 返回
  55 +
  56 +``` json
  57 +{
  58 + "code": 200,
  59 + "data": {
  60 + "list": [
  61 + {
  62 + "batchNo": "201602031002",
  63 + "createTime": "2016-02-03 17:33:08",
  64 + "describe": "",
  65 + "id": 7,
  66 + "limitDateFrom": "2016-01-01",
  67 + "limitDateTo": "2016-01-31",
  68 + "limitTimes": 10,
  69 + "name": "第一批次限购码",
  70 + "reqDepartment": "运营部",
  71 + "status": 0,
  72 + "userUseLimit": 1
  73 + },
  74 + {
  75 + "auditTime": "2016-01-29 18:15:01",
  76 + "batchNo": "201601291001",
  77 + "createTime": "2016-02-03 15:12:51",
  78 + "creatorId": 1111,
  79 + "creatorName": "test",
  80 + "describe": "第1批次限购码",
  81 + "id": 6,
  82 + "limitDateFrom": "2016-01-01",
  83 + "limitDateTo": "2016-01-31",
  84 + "limitSkn": "5123456",
  85 + "limitTimes": 10,
  86 + "name": "第1批次限购码",
  87 + "reqDepartment": "运营部",
  88 + "status": 1,
  89 + "userTypeLimit": "1",
  90 + "userUseLimit": 1
  91 + },
  92 + {
  93 + "auditTime": "2016-01-29 17:56:02",
  94 + "batchNo": "201601291002",
  95 + "createTime": "2016-01-29 17:56:02",
  96 + "creatorId": 1111,
  97 + "creatorName": "test",
  98 + "describe": "第6批次限购码",
  99 + "id": 5,
  100 + "limitDateFrom": "2016-01-01",
  101 + "limitDateTo": "2016-01-31",
  102 + "limitSkn": "5123456",
  103 + "limitTimes": 10,
  104 + "name": "第6批次限购码",
  105 + "reqDepartment": "运营部",
  106 + "status": 1,
  107 + "userTypeLimit": "1",
  108 + "userUseLimit": 1
  109 + }
  110 + ],
  111 + "page": 1,
  112 + "size": 20,
  113 + "total": 3,
  114 + "totalPage": 1
  115 + },
  116 + "md5": "6d6052f3afcec10ba4d4c8490cd8e5eb",
  117 + "message": "getLimitCode success."
  118 +}
  119 +
  120 +```
  121 +
  122 +
  123 +# 更新限购码接口
  124 +
  125 +> 接口名: `/limitCode/updateLimitCode`
  126 +
  127 +### 入参
  128 +
  129 +-------------------------
  130 +|属性名称|类型|例子|说明|是否必填|
  131 +|--------|----|----|----|--------|
  132 +|id|int|6|限购码ID|是|
  133 +|name|string|潮流尖货限购码|限购码名称|是|
  134 +|limitTimes|int|100|数量|是|
  135 +|reqDepartment|string|运营部|申请部门|否|
  136 +|limitDateFrom|string|2016-02-01 14:00:00|起始时间|是|
  137 +|limitDateTo|string|2016-02-20 14:00:00|失效时间|是|
  138 +|describe|string|耐克新款|限购码描述|否|
  139 +|userUseLimit|int|1|用户使用次数|否|
  140 +|userTypeLimit|int|1|用户类型|否
  141 +|limitSkn|string|50012345|限购商品skn|否
  142 +|creatorName|string|张三|创建者名称|否
  143 +|creatorId|int|12401|创建者ID|否
  144 +|createTime|string|2016-01-29 15:00:00|创建时间|否
  145 +|status|int|0|限购码状态0:待审核 1:审核通过 2:驳回 3:过期 4:作废|否
  146 +|reason|string|预算不够|驳回原因|否
  147 +|batchNo|string|201602021023|批次号|是
  148 +|auditTime|string|2016-01-30 15:00:00|审核时间|否
  149 +---------------------
  150 +
  151 +### 返回
  152 +
  153 +``` json
  154 +{
  155 + "code": 500,
  156 + "data": [],
  157 + "md5": "d751713988987e9331980363e24189ce",
  158 + "message": "updateLimitCode success."
  159 +}
  160 +
  161 +```
  162 +
  163 +# 审核限购码接口
  164 +
  165 +> 接口名: `/limitCode/auditLimitCode`
  166 +
  167 +### 入参
  168 +
  169 +-------------------------
  170 +|属性名称|类型|例子|说明|是否必填|
  171 +|--------|----|----|----|--------|
  172 +|id|int|6|限购码ID|是
  173 +|status|int|0|限购码状态0:待审核 1:审核通过 2:驳回 3:过期 4:作废|否
  174 +|reason|string|预算不够|驳回原因|否
  175 +|auditTime|string|2016-01-30 15:00:00|审核时间|否
  176 +---------------------
  177 +
  178 +### 返回
  179 +
  180 +``` json
  181 +{
  182 + "code": 500,
  183 + "data": [],
  184 + "md5": "d751713988987e9331980363e24189ce",
  185 + "message": "auditLimitCode success."
  186 +}
  187 +
  188 +```
  189 +
  190 +# 删除限购码接口
  191 +
  192 +> 接口名: `/limitCode/deleteLimitCode`
  193 +
  194 +### 入参
  195 +
  196 +-------------------------
  197 +|属性名称|类型|例子|说明|是否必填|
  198 +|--------|----|----|----|--------|
  199 +|id|int|6|限购码ID|是
  200 +---------------------
  201 +
  202 +### 返回
  203 +
  204 +``` json
  205 +{
  206 + "code": 200,
  207 + "data": [],
  208 + "md5": "d751713988987e9331980363e24189ce",
  209 + "message": "deleteLimitCode success."
  210 +}
  211 +
  212 +```
  213 +
  214 +# 获取各种状态限购码数量接口
  215 +
  216 +> 接口名: `/limitCode/getLimitCodeCountByStatus`
  217 +
  218 +### 入参
  219 +
  220 +-------------------------
  221 +|属性名称|类型|例子|说明|是否必填|
  222 +|--------|----|----|----|--------|
  223 +---------------------
  224 +
  225 +### 返回
  226 +
  227 +``` json
  228 +{
  229 + "code": 200,
  230 + "data": {
  231 + "0": "1",
  232 + "1": "1",
  233 + "all": "2"
  234 + },
  235 + "md5": "f29559d3d32c56f9cd94c892128cbae8",
  236 + "message": "deleteLimitCode success."
  237 +}
  238 +
  239 +```
  240 +