help_content.md
3.16 KB
帮助内容接口服务定义
添加帮助内容
接口名:
/HelpContentRest/addHelpContent
入参
{
"title":"补开发票",
"categoryId":13,
"content":"如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
"platform":"iphone,android"
}
属性名称 | 类型 | 例子 | 说明 |
---|---|---|---|
title | String | 补开发票 | 帮助标题 |
categoryId | int | 13 | 分类ID |
content | String | 如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。 | 帮助内容 |
platform | String | iphone,android | 显示平台 |
返回
{
"code": 200,
"message": "Add Help Content Success"
}
{
"code":400
"message":"帮助标题不能为空"
}
{
"code":400
"message":"分类ID无效"
}
{
"code":400
"message":"内容无效"
}
{
"code":400
"message":"显示平台无效"
}
{
"code":500
"message":"Add Help Content Fail"
}
修改帮助内容
接口名:
/HelpContentRest/updateHelpContent
入参
{
"id":44,
"title":"补开发票",
"categoryId":13,
"platform":"iphone,android,h5",
"content":"如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。"
}
属性名称 | 类型 | 例子 | 说明 |
---|---|---|---|
id | int | 44 | 帮助内容记录ID |
title | String | 补开发票 | 帮助标题 |
categoryId | int | 13 | 分类ID |
content | String | 如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。 | 帮助内容 |
platform | String | iphone,android | 显示平台 |
返回
{
"code": 200,
"message": "Update Help Content Success"
}
{
"code":400
"message":"Id is null"
}
{
"code":400
"message":"帮助标题不能为空"
}
{
"code":400
"message":"分类ID无效"
}
{
"code":400
"message":"内容无效"
}
{
"code":400
"message":"显示平台无效"
}
{
"code":500
"message":"Upodate Help Content Fail"
}
根据ID获得帮助内容
接口名:
/HelpContentRest/getHelpContentById
入参
{
"id":44
}
属性名称 | 类型 | 例子 | 说明 |
---|---|---|---|
id | int | 44 | 帮助内容记录ID |
返回
{
"code": 200,
"data": {
"categoryId": 13,
"content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
"createTime": 1455438073,
"id": 44,
"platform": [
"iphone",
"android",
"h5"
],
"title": "补开发票",
"updateTime": 1455438842
},
"message": "Help Content"
}
{
"code":400
"message":"Id is null"
}