qianjun / yohobuy-doc · Commits

Go to a project

Authored by qianjun
Commit d43fb7b28429e7f1de481381c81dd00e6e35df36 1 parent cd4b3952

shops012

Inline Side-by-side
Showing 1 changed file with 306 additions and 170 deletions
1 -# 店铺管理员接口服务定义  
2 ----------------------  
3 -  
4 -## 获取店铺管理员列表  
5 -  
6 -> 接口名：`/shops/getShopsAdminList`  
7 -  
8 -### 入参  
9 -  
10 --------------------------  
11 -|属性名称|类型|例子|说明|  
12 -|--------|----|----|----|  
13 -|page|int|2|第几页|  
14 -|size|int|50|每页条数|  
15 ----------------------  
16 -  
17 -### 返回  
18 -  
19 -``` json  
20 -{  
21 - "code":200,  
22 - "message":"list",  
23 - "data":{  
24 -  
25 - }  
26 -}  
27 -```  
28 -  
29 -  
30 -## 添加店铺管理员关系  
31 -> 接口名： `/shops/addAdminRelation`  
32 -  
33 -### 入参  
34 -  
35 --------------------------  
36 -|属性名称|类型|例子|说明|  
37 -|--------|----|----|----|  
38 -|shopsId|int|15|店铺ID|  
39 -|adminPid|int|2951|管理员ID|  
40 -|identity|int|1|身份(1、店长 2、供应商 3、店员)|  
41 ----------------------------  
42 -  
43 -### 返回  
44 -  
45 -```json  
46 -{  
47 - "code":500  
48 - "message":"shops_id is null"  
49 -}  
50 -{  
51 - "code":500  
52 - "message":"admin_pid is null"  
53 -}  
54 -{  
55 - "code":500  
56 - "message":"该关系已存在"  
57 -}  
58 -{  
59 - "code":500  
60 - "message":"添加失败"  
61 -}  
62 -{  
63 - "code":200  
64 - "message":"添加成功"  
65 -}  
66 -  
67 -```  
68 -  
69 -## 删除店铺管理员关系  
70 -> 接口名： `/shops/delAdminRelation`  
71 -  
72 -### 入参  
73 -  
74 --------------------------  
75 -|属性名称|类型|例子|说明|  
76 -|--------|----|----|----|  
77 -|id|int|20|店铺管理员记录ID|  
78 -|shopsId|int|15|店铺ID|  
79 ----------------------------  
80 -  
81 -### 返回  
82 -  
83 -```json  
84 -{  
85 - "code":500  
86 - "message":"id is null"  
87 -}  
88 -{  
89 - "code":200  
90 - "message":"删除成功!"  
91 -}  
92 -```  
93 -  
94 -## 获取管理员关系详情  
95 -  
96 -> 接口名：`/shops/getAdminRelationDetailById`  
97 -  
98 -### 入参  
99 -  
100 --------------------------  
101 -|属性名称|类型|例子|说明|  
102 -|--------|----|----|----|  
103 -|id|int|20|店铺管理员记录ID|  
104 -|shopsId|int|15|店铺ID|  
105 --------------------  
106 -  
107 -### 返回  
108 -  
109 -```json  
110 -{  
111 - "code":500,  
112 - "message":"id is null"  
113 -}  
114 -{  
115 - "code":500,  
116 - "message":"shops_id is null"  
117 -}  
118 -{  
119 - "code":500,  
120 - "message":"暂无数据"  
121 -}  
122 -{  
123 - "code":200,  
124 - "message":"list",  
125 - "data":{  
126 -  
127 - }  
128 -}  
129 -```  
130 -  
131 -  
132 -## 修改店铺管理员关系  
133 -  
134 -> 接口名: `/shops/updateAdminRalation`  
135 -  
136 -### 入参  
137 -  
138 --------------------------  
139 -|属性名称|类型|例子|说明|  
140 -|--------|----|----|----|  
141 -|shopDomain|String|debao|店铺域名|  
142 -|shopsId|int|15|店铺ID|  
143 ------------------------------  
144 -  
145 -### 返回  
146 -  
147 -```json  
148 -{  
149 - "code":500  
150 - "message":"id is null"  
151 -}  
152 -{  
153 - "code":500  
154 - "message":"shops_id is null"  
155 -}  
156 -{  
157 - "code":500  
158 - "message":"admin_pid is null"  
159 -}  
160 -{  
161 - "code":500  
162 - "message":"该关系已存在"  
163 -}  
164 -{  
165 - "code":200  
166 - "message":"修改成功"  
167 -}  
168 -  
169 -```  
170 - 1 +# 店铺管理员接口服务定义
  2 +---------------------
  3 +
  4 +## 获取店铺管理员列表
  5 +
  6 +> 接口名：`/shops/ShopsAdminRest/getShopsAdminList`
  7 +
  8 +### 入参
  9 +``` json
  10 +{
  11 + "page":2,
  12 + "size":12
  13 +}
  14 +```
  15 +-------------------------
  16 +|属性名称|类型|例子|说明|
  17 +|--------|----|----|----|
  18 +|page|int|2|第几页|
  19 +|size|int|50|每页条数|
  20 +---------------------
  21 +
  22 +### 返回
  23 +
  24 +``` json
  25 +{
  26 + "code": 200,
  27 + "data": {
  28 + "list": [
  29 + {
  30 + "adminName": "",
  31 + "adminPid": 10180,
  32 + "createTime": "2016-01-14 11:03:44",
  33 + "id": 822,
  34 + "identity": 1,
  35 + "shopName": "MO&Co.",
  36 + "shopsId": 420,
  37 + "updateTime": "1970-01-01 08:00:00"
  38 + },
  39 + {
  40 + "adminName": "成凤驹",
  41 + "adminPid": 2738,
  42 + "createTime": "2016-01-11 16:49:32",
  43 + "id": 820,
  44 + "identity": 7,
  45 + "shopName": "Faroma",
  46 + "shopsId": 430,
  47 + "updateTime": "1970-01-01 08:00:00"
  48 + },
  49 + {
  50 + "adminName": "朱云青",
  51 + "adminPid": 2314,
  52 + "createTime": "2016-01-11 16:49:15",
  53 + "id": 819,
  54 + "identity": 7,
  55 + "shopName": "Faroma",
  56 + "shopsId": 430,
  57 + "updateTime": "1970-01-01 08:00:00"
  58 + },
  59 + {
  60 + "adminName": "",
  61 + "adminPid": 10040,
  62 + "createTime": "2016-01-11 16:48:37",
  63 + "id": 818,
  64 + "identity": 6,
  65 + "shopName": "朴坊Simplemill",
  66 + "shopsId": 319,
  67 + "updateTime": "1970-01-01 08:00:00"
  68 + },
  69 + {
  70 + "adminName": "",
  71 + "adminPid": 2944,
  72 + "createTime": "2016-01-11 16:47:27",
  73 + "id": 817,
  74 + "identity": 7,
  75 + "shopName": "WWTorres",
  76 + "shopsId": 429,
  77 + "updateTime": "1970-01-01 08:00:00"
  78 + },
  79 + {
  80 + "adminName": "朱云青",
  81 + "adminPid": 2314,
  82 + "createTime": "2016-01-11 16:47:15",
  83 + "id": 816,
  84 + "identity": 7,
  85 + "shopName": "WWTorres",
  86 + "shopsId": 429,
  87 + "updateTime": "1970-01-01 08:00:00"
  88 + },
  89 + {
  90 + "adminName": "",
  91 + "adminPid": 3161,
  92 + "createTime": "2016-01-08 15:21:11",
  93 + "id": 815,
  94 + "identity": 7,
  95 + "shopName": "MO&Co.edition",
  96 + "shopsId": 426,
  97 + "updateTime": "1970-01-01 08:00:00"
  98 + },
  99 + {
  100 + "adminName": "",
  101 + "adminPid": 3069,
  102 + "createTime": "2016-01-08 15:20:58",
  103 + "id": 814,
  104 + "identity": 7,
  105 + "shopName": "MO&Co.edition",
  106 + "shopsId": 426,
  107 + "updateTime": "1970-01-01 08:00:00"
  108 + },
  109 + {
  110 + "adminName": "",
  111 + "adminPid": 10172,
  112 + "createTime": "2016-01-08 14:00:53",
  113 + "id": 813,
  114 + "identity": 7,
  115 + "shopName": "ELECOM 宜丽客",
  116 + "shopsId": 421,
  117 + "updateTime": "1970-01-01 08:00:00"
  118 + },
  119 + {
  120 + "adminName": "朱云青",
  121 + "adminPid": 2314,
  122 + "createTime": "2016-01-08 14:00:37",
  123 + "id": 812,
  124 + "identity": 7,
  125 + "shopName": "ELECOM 宜丽客",
  126 + "shopsId": 421,
  127 + "updateTime": "1970-01-01 08:00:00"
  128 + },
  129 + {
  130 + "adminName": "",
  131 + "adminPid": 3161,
  132 + "createTime": "2016-01-08 13:23:48",
  133 + "id": 811,
  134 + "identity": 7,
  135 + "shopName": "MO&Co.",
  136 + "shopsId": 420,
  137 + "updateTime": "1970-01-01 08:00:00"
  138 + },
  139 + {
  140 + "adminName": "",
  141 + "adminPid": 3069,
  142 + "createTime": "2016-01-08 13:23:32",
  143 + "id": 810,
  144 + "identity": 7,
  145 + "shopName": "MO&Co.",
  146 + "shopsId": 420,
  147 + "updateTime": "1970-01-01 08:00:00"
  148 + }
  149 + ],
  150 + "page": 2,
  151 + "size": 12,
  152 + "total": 803,
  153 + "totalPage": 67
  154 + },
  155 + "message": "操作成功"
  156 +}
  157 +```
  158 +
  159 +
  160 +## 添加店铺管理员关系
  161 +> 接口名： `/shops/ShopsAdminRest/addAdminRelation`
  162 +
  163 +### 入参
  164 +```json
  165 +{
  166 + "shopsId":15,
  167 + "adminPid":2,
  168 + "identity":12
  169 +}
  170 +```
  171 +-------------------------
  172 +|属性名称|类型|例子|说明|
  173 +|--------|----|----|----|
  174 +|shopsId|int|15|店铺ID|
  175 +|adminPid|int|2951|管理员ID|
  176 +|identity|int|1|身份(1、店长 2、供应商 3、店员) 可选 默认为1|
  177 +---------------------------
  178 +
  179 +### 返回
  180 +
  181 +```json
  182 +{
  183 + "code":500
  184 + "message":"shopsId is null"
  185 +}
  186 +{
  187 + "code":500
  188 + "message":"adminPid is null"
  189 +}
  190 +{
  191 + "code":500
  192 + "message":"该关系已存在"
  193 +}
  194 +{
  195 + "code":500
  196 + "message":"添加失败"
  197 +}
  198 +{
  199 + "code":200
  200 + "message":"添加成功"
  201 +}
  202 +
  203 +```
  204 +
  205 +## 删除店铺管理员关系
  206 +> 接口名： `/shops/delAdminRelation`
  207 +
  208 +### 入参
  209 +
  210 +-------------------------
  211 +|属性名称|类型|例子|说明|
  212 +|--------|----|----|----|
  213 +|id|int|20|店铺管理员记录ID|
  214 +|shopsId|int|15|店铺ID|
  215 +---------------------------
  216 +
  217 +### 返回
  218 +
  219 +```json
  220 +{
  221 + "code":500
  222 + "message":"id is null"
  223 +}
  224 +{
  225 + "code":200
  226 + "message":"删除成功!"
  227 +}
  228 +```
  229 +
  230 +## 获取管理员关系详情
  231 +
  232 +> 接口名：`/shops/getAdminRelationDetailById`
  233 +
  234 +### 入参
  235 +
  236 +-------------------------
  237 +|属性名称|类型|例子|说明|
  238 +|--------|----|----|----|
  239 +|id|int|20|店铺管理员记录ID|
  240 +|shopsId|int|15|店铺ID|
  241 +-------------------
  242 +
  243 +### 返回
  244 +
  245 +```json
  246 +{
  247 + "code":500,
  248 + "message":"id is null"
  249 +}
  250 +{
  251 + "code":500,
  252 + "message":"shops_id is null"
  253 +}
  254 +{
  255 + "code":500,
  256 + "message":"暂无数据"
  257 +}
  258 +{
  259 + "code":200,
  260 + "message":"list",
  261 + "data":{
  262 +
  263 + }
  264 +}
  265 +```
  266 +
  267 +
  268 +## 修改店铺管理员关系
  269 +
  270 +> 接口名: `/shops/updateAdminRalation`
  271 +
  272 +### 入参
  273 +
  274 +-------------------------
  275 +|属性名称|类型|例子|说明|
  276 +|--------|----|----|----|
  277 +|shopDomain|String|debao|店铺域名|
  278 +|shopsId|int|15|店铺ID|
  279 +-----------------------------
  280 +
  281 +### 返回
  282 +
  283 +```json
  284 +{
  285 + "code":500
  286 + "message":"id is null"
  287 +}
  288 +{
  289 + "code":500
  290 + "message":"shops_id is null"
  291 +}
  292 +{
  293 + "code":500
  294 + "message":"admin_pid is null"
  295 +}
  296 +{
  297 + "code":500
  298 + "message":"该关系已存在"
  299 +}
  300 +{
  301 + "code":200
  302 + "message":"修改成功"
  303 +}
  304 +
  305 +```
  306 +