Blame view

inferface-document/brandSeries.md 3.94 KB
chenchao authored
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
# 品牌款型系列管理接口服务定义
---------------------

# 添加品牌款型系列接口

> 接口名: `/brandSeries/add`

### 入参

-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|seriesName | string | 羽绒服系列 |名称|是|
|shopsId | int | 1 | 店铺id | 是|
|brandId | int | 1 | 店铺id下的某个品牌id | 是|
|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 是|
|orderBy | int | 1 | 排序值 | 否|
---------------------

### 返回

``` json
{
  "code":200,--若失败为500
  "message":"success"
}

```


# 获取品牌款型系列列表(有分页)

> 接口名: `/brandSeries/queryAll`

### 入参

-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
|seriesName | string | 羽绒服系列 |名称|是|
|shopsId | int | 1 | 店铺id | 是|
|brandId | int | 1 | 店铺id下的某个品牌id | 是|
|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 是|
chenchao authored
44 45
|page | int | 1 | 页码数,默认1 | 否|
|size | int | 10 | 记录数,默认10条 | 否|
chenchao authored
46 47
|status | int | 1 | 状态 1:打开 0:关闭 | 否|
chenchao authored
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
--------------------------------

### 返回

``` json
{
  "code": 200,--若失败为500
  "data": {
    "list": [
      {
        "brandId": 5,
        "id": 48,
        "seriesName": "test-cc-u",
        "shopsId": 5,
        "status": 1,
        "type": 5
      }
    ],
    "page": 0,-第几页
    "size": 0,-单页记录数
    "total": 437,--总数
    "totalPage": 1--总页数
  },
  "md5": "81531967e3291781f608555ca63ccd28",
  "message": "success"
}

```


# 更新品牌款型系列接口

> 接口名: `/brandSeries/update`

### 入参

-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|int|15|ID|是|
|seriesName | string | 羽绒服系列 |名称|否|
|shopsId | int | 1 | 店铺id | 否|
|brandId | int | 1 | 店铺id下的某个品牌id | 否|
|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 否|
|orderBy | int | 1 | 排序值 | 否|
---------------------

### 返回

``` json
{
  "code": 200,--若失败为500
  "data": [],
  "md5": "d751713988987e9331980363e24189ce",
  "message": "success"
}

```



# 获取单个品牌款型系列接口

> 接口名: `/brandSeries/queryById/{id}`

{id} 具体的品牌款型系列id值,数据类型:int
例:/brandSeries/queryById/14

http method : get & post all ok;

### 入参

-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|

---------------------

### 返回

``` json
{
  "code": 200,--若失败为500
  "data":{
        "brandId": 286,
    "id": 13,
    "orderBy": 4,
    "parentId": 0,
    "seriesName": "Mikio Sakabe",
    "shopsId": 1,
    "status": 1
      },
  "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
  "message": "success"
}

```

# 打开品牌款型系列接口

> 接口名: `/brandSeries/open/{id}`

{id} 具体的品牌款型系列id值,数据类型:int
例:/brandSeries/open/14

### 入参

-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|

---------------------

### 返回

``` json
{
  "code": 200,--若失败为500
  "data": [],
  "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
  "message": "success"
}

```

# 关闭品牌款型系列接口(restfull 风格)

> 接口名: `/brandSeries/close/{id}`

{id} 具体的品牌款型系列id值,数据类型:int
例:/brandSeries/close/14

### 入参

-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|

---------------------

### 返回

``` json
{
  "code": 200,--若失败为500
  "data": [ ],
  "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
  "message": "success"
}

```