Authored by lingmin

相关接口定义

# 活动模板接口服务定义
----------------------
**1、获取支付管理列表**
# 查询模板列表接口
获取支付管理列表(/PayManageController/findPayManageList)
> 接口名:`activityTemplate/selectTemplateList`
**请求参数**
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|status|integer|1|状态:0 不启用 ,1 启用 |否|
----------------------------------
**请求示例**
### 返回
注意,通用的头部没有列出
``` json
{
"code":200,
"message":"请求成功",
"data": [
{
"createTime": 1453966206,
"id": 1,
"image": "", // 图片链接
"shareId": 0,
"status": 1, // 0 不启用 ,1 启用
"title": "",
"url": ""
}
]
}
```
# 添加模板接口
http://localhost:8080/platform/PayManageController/findPayManageList
> 接口名:`activityTemplate/addTemplate`
### 入参
**响应**
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|title|string|新人专享活动模板|模板标题|是|
|image|string|http://yoho.cn/18282.jpg|图片地址|否|
|url|string|http://yoho.cn/18282.template|模板地址|否|
|shareId|integer|1|共享ID|否|
----------------------------------
code为200即为成功,否则是失败。 响应JSON格式如下所示:
### 返回
``` json
{
"code":200,
"message":"添加成功!"
}
```
{
"code": 200,
"data":{
"currentPage":1
"rows":[{"id": 2,
"payName": "支付宝",
"recommendOrderPage":1,
"recommendWords":"",
"sortNumber":2,
"recommendText1":"",
"recommendText2":"",
"status":1,
"createTime":"";
"updateTime":""},{
"id": 3,
"payName": "微信",
"recommendOrderPage":1,
"recommendWords":"",
"sortNumber":1,
"recommendText1":"",
"recommendText2":"",
"status":1,
"createTime":"";
"updateTime":""}],
"pageSize":10,
"total":10,
"totalPage":1
},
"md5": "d751713988987e9331980363e24189ce",
"message": "操作成功"
}
# 更新模板接口
> 接口名:`activityTemplate/updateTeplate`
**2、获取支付方式详情**
### 入参
获取支付方式详情(/PayManageController/findPayInfoById)
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|主键|是|
|title|string|新人专享活动模板|模板标题|是|
|image|string|http://yoho.cn/18282.jpg|图片地址|否|
|url|string|http://yoho.cn/18282.template|模板地址|否|
|shareId|integer|1|共享ID|否|
----------------------------------
**请求参数**
### 返回
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|id |int | 否 |1 | | |
``` json
{
"code":200,
"message":"添加成功!"
}
```
# 开启模板接口
**请求示例**
> 接口名:`activityTemplate/publishTemplate`
注意,通用的头部没有列出
### 入参
http://localhost:8080/platform/PayManageController/findPayInfoById
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|主键|是|
----------------------------------
{
"id":2
}
### 返回
``` json
{
"code":200,
"message":"操作成功!"
}
```
**响应**
# 关闭模板接口
{
"code": 200,
"data": {
"id": 2,
"payName": "支付宝",
"recommendOrderPage":1,
"recommendWords":"",
"sortNumber":2,
"recommendText1":"",
"recommendText2":"",
"status":1,
"createTime":"";
"updateTime":""
},
"md5": "d751713988987e9331980363e24189ce",
"message": "操作成功"
}
> 接口名:`activityTemplate/closeTemplate`
**3、新增支付方式**
### 入参
新增支付方式(/PayManageController/createPayMode)
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|主键|是|
----------------------------------
**请求参数**
### 返回
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|payName |String | 否 |支付宝 | | 支付方式名称 |
|recommendOrderPage |int | 否 |0 | 0 |是否推荐到确认订单页,0-否;1-是|
|recommendWords |String | 是 | | | 推荐文案 |
|sortNumber |int | 否 |1 | 0 | 前端排序值,数字越大越靠前 |
|recommendText1 |String | 是 | | |推荐语1 |
|recommendText2 |String | 是 | | | 推荐语2 |
``` json
{
"code":200,
"message":"操作成功!"
}
```
# 根据条件查询活动商品列表接口
**请求示例**
> 接口名:`activityTemplate/getProductListByCondition`
注意,通用的头部没有列出
### 入参
http://localhost:8080/platform/PayManageController/createPayMode
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|templateId|integer|1|模板ID|是|
|productSkn|integer|1|商品SKN|否|
----------------------------------
{
"payName":"支付宝",
"recommendOrderPage":1,
"recommendWords":"推荐文案",
"sortNumber":2,
"recommendText1":""
}
### 返回
**响应**
``` json
{
"code": 200,
"data": {
"list": [
{
"id": 1,
"isRecommend": true,
"orderBy": 110,
"productSkn": 51125277,
"status": 1,
"templateId": 2
"code": 200,
"data": {},
"md5": "d751713988987e9331980363e24189ce",
"message": "操作成功"
}
],
"page": 1,
"size": 10,
"total": 1,
"totalPage": 1
},
"message": "Temp SKN list"
}
```
# 插入活动商品信息接口
> 接口名:`activityTemplate/insertProduct`
**4、编辑支付方式详情**
### 入参
编辑支付方式(/PayManageController/updatePayInfoById)
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|templateId|integer|1|模板ID|是|
|productSkn|integer|1|商品SKN|是|
----------------------------------
**请求参数**
### 返回
``` json
{
"code": 200,
"message": "添加成功",
}
```
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|id |int | 否 |1 | | |
|payName |String | 否 |支付宝 | | 支付方式名称,不可修改 |
|recommendOrderPage |int | 否 |0 | 0 |是否推荐到确认订单页,0-否;1-是|
|recommendWords |String | 是 | | | 推荐文案 |
|sortNumber |int | 否 |1 | 0 | 前端排序值,数字越大越靠前 |
|recommendText1 |String | 是 | | |推荐语1 |
|recommendText2 |String | 是 | | | 推荐语2 |
# 更新商品信息接口
**请求示例**
> 接口名:`activityTemplate/updateProduct`
注意,通用的头部没有列出
### 入参
http://localhost:8080/platform/PayManageController/updatePayInfoById
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|商品ID|是|
|orderBy|integer|1|排序号|否|
|isRecommend|integer|1|是否推荐|否|
|status|integer|1|是否启用|否|
----------------------------------
{
"id":2,
"recommendOrderPage":1,
"recommendWords":"推荐文案",
"sortNumber":2
}
### 返回
**响应**
``` json
{
{
"code": 200,
"message": "操作成功",
}
```
"data": {},
"md5": "d751713988987e9331980363e24189ce",
"message": "操作成功"
}
# 删除商品信息接口
> 接口名:`activityTemplate/delOneProduct`
**5、关闭/开启支付方式**
### 入参
关闭/开启支付方式(/PayManageController/offOrOnPayModeById)
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|主键|是|
----------------------------------
**请求参数**
### 返回
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|id |int | 否 |1 | | |
|status |int | 否 |1 | | 0-关闭,1-开启 |
如果删除失败,可能是没有删除权限。
**请求示例**
``` json
{
"code":200,
"message":"操作成功!"
}
```
注意,通用的头部没有列出
http://localhost:8080/platform/PayManageController/offOrOnPayModeById
{
"id":2,
"status":1
}
**响应**
{
"code": 200,
"data": {},
"md5": "d751713988987e9331980363e24189ce",
"message": "操作成功"
}
... ...