notice.md
3.75 KB
公告管理接口服务定义
查询公告接口
接口名:
notice/getList
入参
属性名称 | 类型 | 例子 | 说明 | 是否必填 |
---|---|---|---|---|
title | string | 新人 | 标题,模糊查询 | 否 |
position | integer | 1 | 位置 | 否 |
showChannels | string | 1 | 频道, 当位置为首页(2)时,可以选择 1.男首、2.女首、3.潮童、4.创意生活 | 否 |
返回
{
"code": 200,
"data": {
"list": [
{
"createTime": 1451298094,
"endTime": "2015-12-23 12:05:26",
"id": 15,
"img": "",
"position": 2,
"showChannels": "1,2,3",
"startTime": "2015-12-23 12:05:26",
"status": 1,
"title": "新人专享",
"url": "{\"action\":\"go.activitytemplate\",\"url\":\"http://m.yohobuy.com?template_id=3&title=新人专享&type=1\"}"
}
],
"page": 1,
"size": 20,
"total": 1,
"totalPage": 1
},
"message": "Notice List"
}
添加公告接口
接口名:
notice/addNotice
入参
属性名称 | 类型 | 例子 | 说明 | 是否必填 |
---|---|---|---|---|
title | string | 新人 | 标题,模糊查询 | 是 |
position | integer | 1 | 位置 | 是 |
showChannels | string | 1 | 首页频道 | 否 |
url | string | http://test.com | 链接 | 否 |
img | string | http://test.jpg | 图片链接 | 否 |
startTime | integer | 1450843526 | 开始时间 | 否 |
endTime | integer | 1451450631 | 结束时间,结束时间大于开始时间 | 否 |
返回
{
"code": 200,
"message": "添加成功"
}
获取公告接口
接口名:
notice/getNotice
入参
属性名称 | 类型 | 例子 | 说明 | 是否必填 |
---|---|---|---|---|
id | integer | 22 | 主键 | 是 |
返回
{
"code": 200,
"data": {
"createTime": 1456299447,
"endTime": 1450843526,
"id": 22,
"img": "http://img.cn.png",
"position": 2,
"showChannels": "1,2,3",
"startTime": 1450843526,
"status": 0,
"title": "这是一个测试",
"url": "http://url.cn"
},
"message": "Notice Info"
}
更新公告接口
接口名:
notice/updateNotice
入参
属性名称 | 类型 | 例子 | 说明 | 是否必填 |
---|---|---|---|---|
id | integer | 22 | 主键 | 是 |
title | string | 新人 | 标题,模糊查询 | 是 |
position | integer | 1 | 位置 | 是 |
showChannels | string | 1 | 首页频道 | 否 |
url | string | http://test.com | 链接 | 否 |
img | string | http://test.jpg | 图片链接 | 否 |
startTime | integer | 1450843526 | 开始时间 | 否 |
endTime | integer | 1451450631 | 结束时间,结束时间大于开始时间 | 否 |
返回
{
"code": 200,
"message": "修改成功"
}
删除公告接口
接口名:
notice/delNotice
入参
属性名称 | 类型 | 例子 | 说明 | 是否必填 |
---|---|---|---|---|
id | integer | 21 | 主键 | 是 |
返回
{
"code": 200,
"message": "删除成功"
}
设置公告状态
接口名:
notice/setStatus
入参
属性名称 | 类型 | 例子 | 说明 | 是否必填 |
---|---|---|---|---|
id | integer | 21 | 主键 | 是 |
status | integer | 1 | 状态:0 不启用 ,1 启用 | 否 |
返回
{
"code": 200,
"message": "修改成功"
}