michaelcao / yohobuy-doc · Commits

Go to a project

Authored by qianjun
Commit d5247f883334123f2113966961de4f06789e4f22 1 parent 7031d98c

helpcontent008

Inline Side-by-side
Showing 1 changed file with 340 additions and 38 deletions
... ... @@ -420,20 +420,38 @@ or
}
```
## 根据ID获得帮助内容
## 获取帮助内容总记录数
> 接口名：`/HelpContentRest/getHelpContentById`
> 接口名：`/HelpContentRest/getHelpContentCount`
### 入参
无
---------------------
### 返回
``` json
{
"id":44
"code": 200,
"data": 22,
"message": "成功"
}
```
## 根据分类ID查帮助内容
> 接口名：`/HelpContentRest/getHelpContentByCategoryId`
### 入参
``` json
{
"categoryId": 13
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|44|帮助内容记录ID|
|categoryId|int|13|分类ID|
---------------------
### 返回
... ... @@ -441,41 +459,91 @@ or
``` json
{
"code": 200,
"data": {
"categoryId": 13,
"content": "如订单未选择发票需要补寄，请您联系有货客服，我们可以为您补开三个自然月内订单的发票，但是需运费到付。",
"createTime": 1455438073,
"id": 44,
"platform": [
"iphone",
"android",
"h5"
],
"title": "补开发票",
"updateTime": 1455438842
},
"message": "Help Content"
"data": [
{
"categoryId": 13,
"content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
"createTime": 1437545220,
"id": 1,
"platform": "iphone,android",
"status": 1,
"title": "取消订单",
"updateTime": 1437548510
},
{
"categoryId": 13,
"content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
"createTime": 1437562767,
"id": 10,
"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": 1437562842,
"id": 13,
"platform": "iphone,android",
"status": 1,
"title": "修改订单地址/电话",
"updateTime": 0
},
{
"categoryId": 13,
"content": "3",
"createTime": 1437566035,
"id": 16,
"platform": "iphone,android",
"status": 1,
"title": "2",
"updateTime": 0
},
{
"categoryId": 13,
"content": "4",
"createTime": 1437566047,
"id": 17,
"platform": "iphone,android",
"status": 1,
"title": "3",
"updateTime": 0
}
],
"message": "Help Content List by CategoryId"
}
or
{
"code":400
"message":"Id is null"
"message":"分类ID无效"
}
```
## 根据ID获得帮助内容
## 根据平台查帮助内容
> 接口名：`/HelpContentRest/getHelpContentById`
> 接口名：`/HelpContentRest/getHelpContentByPlatform`
### 入参
``` json
{
"id":44
"platform": "iphone,android"
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|44|帮助内容记录ID|
|platform|String|iphone,android|显示平台|
---------------------
### 返回
... ... @@ -483,24 +551,258 @@ or
``` json
{
"code": 200,
"data": {
"categoryId": 13,
"content": "如订单未选择发票需要补寄，请您联系有货客服，我们可以为您补开三个自然月内订单的发票，但是需运费到付。",
"createTime": 1455438073,
"id": 44,
"platform": [
"iphone",
"android",
"h5"
],
"title": "补开发票",
"updateTime": 1455438842
},
"message": "Help Content"
"data": [
{
"categoryId": 13,
"content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
"createTime": 1437545220,
"id": 1,
"platform": "iphone,android",
"status": 1,
"title": "取消订单",
"updateTime": 1437548510
},
{
"categoryId": 13,
"content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
"createTime": 1437562767,
"id": 10,
"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": 1437562842,
"id": 13,
"platform": "iphone,android",
"status": 1,
"title": "修改订单地址/电话",
"updateTime": 0
},
{
"categoryId": 13,
"content": "3",
"createTime": 1437566035,
"id": 16,
"platform": "iphone,android",
"status": 1,
"title": "2",
"updateTime": 0
},
{
"categoryId": 13,
"content": "4",
"createTime": 1437566047,
"id": 17,
"platform": "iphone,android",
"status": 1,
"title": "3",
"updateTime": 0
}
],
"message": "Help Content List by CategoryId"
}
or
{
"code":400
"message":"Id is null"
"message":"分类ID无效"
}
```
## 根据分类ID查帮助内容
> 接口名：`/HelpContentRest/getHelpContentByCategoryId`
### 入参
``` json
{
"categoryId": 13
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|categoryId|int|13|分类ID|
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"categoryId": 13,
"content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
"createTime": 1437545220,
"id": 1,
"platform": "iphone,android",
"status": 1,
"title": "取消订单",
"updateTime": 1437548510
},
{
"categoryId": 13,
"content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
"createTime": 1437562767,
"id": 10,
"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": 1437562842,
"id": 13,
"platform": "iphone,android",
"status": 1,
"title": "修改订单地址/电话",
"updateTime": 0
},
{
"categoryId": 13,
"content": "3",
"createTime": 1437566035,
"id": 16,
"platform": "iphone,android",
"status": 1,
"title": "2",
"updateTime": 0
},
{
"categoryId": 13,
"content": "4",
"createTime": 1437566047,
"id": 17,
"platform": "iphone,android",
"status": 1,
"title": "3",
"updateTime": 0
}
],
"message": "Help Content List by CategoryId"
}
or
{
"code":400
"message":"分类ID无效"
}
```
## 帮助内容
> 接口名：`/HelpContentRest/getHelpContentByCategoryId`
### 入参
``` json
{
"categoryId": 13
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|categoryId|int|13|分类ID|
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"categoryId": 13,
"content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
"createTime": 1437545220,
"id": 1,
"platform": "iphone,android",
"status": 1,
"title": "取消订单",
"updateTime": 1437548510
},
{
"categoryId": 13,
"content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
"createTime": 1437562767,
"id": 10,
"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": 1437562842,
"id": 13,
"platform": "iphone,android",
"status": 1,
"title": "修改订单地址/电话",
"updateTime": 0
},
{
"categoryId": 13,
"content": "3",
"createTime": 1437566035,
"id": 16,
"platform": "iphone,android",
"status": 1,
"title": "2",
"updateTime": 0
},
{
"categoryId": 13,
"content": "4",
"createTime": 1437566047,
"id": 17,
"platform": "iphone,android",
"status": 1,
"title": "3",
"updateTime": 0
}
],
"message": "Help Content List by CategoryId"
}
or
{
"code":400
"message":"分类ID无效"
}
```
... ...