help_content.md 9.08 KB

Raw Blame History Permalink



帮助内容接口服务定义


添加帮助内容


接口名：/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"
}


获取所有帮助内容


接口名：/HelpContentRest/getAllHelpContent


入参

{
    "categoryId":13,
    "platform":"iphone,android"
}
or
{
    "categoryId":13,
}
or
{
    "platform":"iphone,android"
}
or
{ }


注意：如果不传入参数，必须传入{}


属性名称
类型
例子
说明


categoryId
int
13
分类ID(可选)


platform
String
iphone,android
显示平台(可选)


返回

{
  "code": 200,
  "data": [
    {
      "categoryId": 13,
      "content": "如订单未选择发票需要补寄，请您联系有货客服，我们可以为您补开三个自然月内订单的发票，但是需运费到付。",
      "createTime": 1455438073,
      "id": 44,
      "platform": "iphone,android,h5",
      "status": 1,
      "title": "补开发票",
      "updateTime": 1455438842
    },
    {
      "categoryId": 13,
      "content": "4",
      "createTime": 1437566047,
      "id": 17,
      "platform": "iphone,android",
      "status": 1,
      "title": "3",
      "updateTime": 0
    },
    {
      "categoryId": 13,
      "content": "3",
      "createTime": 1437566035,
      "id": 16,
      "platform": "iphone,android",
      "status": 1,
      "title": "2",
      "updateTime": 0
    },
    {
      "categoryId": 13,
      "content": "订单生成后无法修改收货人信息，请您联系有货客服处理。",
      "createTime": 1437562842,
      "id": 13,
      "platform": "iphone,android",
      "status": 1,
      "title": "修改订单地址/电话",
      "updateTime": 0
    },
    {
      "categoryId": 13,
      "content": "因为网络问题，信息更新有所延迟，导致无法显示，请您保持网络顺畅情况下，重新登录进入再查看。",
      "createTime": 1437562792,
      "id": 11,
      "platform": "iphone,android",
      "status": 1,
      "title": "下单后看不到订单",
      "updateTime": 0
    },
    {
      "categoryId": 13,
      "content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
      "createTime": 1437562767,
      "id": 10,
      "platform": "iphone,android",
      "status": 1,
      "title": "订单内容的修改",
      "updateTime": 0
    },
    {
      "categoryId": 13,
      "content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
      "createTime": 1437545220,
      "id": 1,
      "platform": "iphone,android",
      "status": 1,
      "title": "取消订单",
      "updateTime": 1437548510
    }
  ],
  "message": "All Help Content Platform List"
}


根据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"
}


根据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"
}


根据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"
}


根据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"
}