help_category.md
12 KB
帮助分类接口服务定义
添加帮助分类
接口名：
/HelpCategoryRest/addCategory
入参
{
"categoryName":"订单问题",
"parentId":0,
"platform":"iphone,android"
}| 属性名称 | 类型 | 例子 | 说明 |
|---|---|---|---|
| categoryName | String | 订单问题 | 分类名称 |
| parentId | int | 0 | 父分类ID |
| platform | String | iphone,android | 显示平台 |
返回
{
"code": 200,
"message": "Add Help Category Success"
}
or
{
"code":400
"message":"分类名称不能为空"
}
or
{
"code":400
"message":"分类ID无效"
}
or
{
"code":400
"message":"显示平台无效"
}
or
{
"code":500
"message":"Add Help Category Fail"
}修改帮助分类
接口名：
/HelpCategoryRest/updateHelpCategory
入参
{
"id":46,
"categoryName":"订单问题2期项目",
"parentId":0,
"platform":"iphone,android"
}| 属性名称 | 类型 | 例子 | 说明 |
|---|---|---|---|
| id | int | 46 | 帮助分类记录ID |
| categoryName | String | 订单问题 | 分类名称 |
| parentId | int | 0 | 父分类ID |
| platform | String | iphone,android | 显示平台 |
返回
{
"code": 200,
"message": "Update Help Category Success"
}
or
{
"code":400
"message":"Id is null"
}
or
{
"code":400
"message":"分类名称不能为空"
}
or
{
"code":400
"message":"分类ID无效"
}
or
{
"code":400
"message":"显示平台无效"
}
or
{
"code":500
"message":"Update Help Category Fail"
}根据ID获得帮助分类
接口名：
/HelpCategoryRest/getHelpCategoryById
入参
{
"id":46
}| 属性名称 | 类型 | 例子 | 说明 |
|---|---|---|---|
| id | int | 46 | 帮助分类记录ID |
返回
{
"code": 200,
"data": {
"categoryName": "订单问题2期项目",
"createTime": 1456281715,
"id": 46,
"parentId": 0,
"platform": [
"iphone",
"android"
],
"updateTime": 1456283370
},
"message": "Help Category"
}
or
{
"code":400
"message":"Id is null"
}根据父id获取帮助分类
接口名：
/HelpCategoryRest/getCategoryListByPid
入参
{
"parentId":0
}| 属性名称 | 类型 | 例子 | 说明 |
|---|---|---|---|
| parentId | int | 0 | 父分类ID |
返回
{
"code": 200,
"data": [
{
"categoryName": "订单问题",
"createTime": 1437544209,
"id": 12,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "购物问题",
"createTime": 1437544351,
"id": 16,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "其他问题",
"createTime": 1437544406,
"id": 20,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "第四个一级",
"createTime": 1437547671,
"id": 24,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "订单问题2期项目",
"createTime": 1456281715,
"id": 46,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 1456283370
},
{
"categoryName": "订单问题",
"createTime": 1456284113,
"id": 48,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
}
],
"message": "Help Category List"
}
or
{
"code":400
"message":"分类ID无效"
}
获取所有帮助分类
接口名：
/HelpCategoryRest/getAllHelpCategory
入参
{
}返回
{
"code": 200,
"data": [
{
"categoryName": "订单问题",
"createTime": 1456284113,
"id": 48,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "钱军",
"createTime": 1456282636,
"id": 47,
"parentId": 12,
"platform": "iphone",
"status": 1,
"updateTime": 0
},
{
"categoryName": "订单问题2期项目",
"createTime": 1456281715,
"id": 46,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 1456283370
},
{
"categoryName": "测试新版重构内容添加",
"createTime": 1448868521,
"id": 45,
"parentId": 16,
"platform": "iphone,android,h5",
"status": 1,
"updateTime": 0
},
{
"categoryName": "第四个二级其他问题修改23",
"createTime": 1437552851,
"id": 29,
"parentId": 20,
"platform": "iphone,android",
"status": 1,
"updateTime": 1437555718
},
{
"categoryName": "订单修改",
"createTime": 1437547796,
"id": 25,
"parentId": 12,
"platform": "iphone,android",
"status": 1,
"updateTime": 1445320680
},
{
"categoryName": "第四个一级",
"createTime": 1437547671,
"id": 24,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "优惠券说明",
"createTime": 1437544461,
"id": 23,
"parentId": 20,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "YOHO币",
"createTime": 1437544431,
"id": 22,
"parentId": 20,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "VIP制度说明",
"createTime": 1437544417,
"id": 21,
"parentId": 20,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "其他问题",
"createTime": 1437544406,
"id": 20,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "售后服务",
"createTime": 1437544393,
"id": 19,
"parentId": 16,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "验货签收",
"createTime": 1437544382,
"id": 18,
"parentId": 16,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "常见支付问题",
"createTime": 1437544366,
"id": 17,
"parentId": 16,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "购物问题",
"createTime": 1437544351,
"id": 16,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "包裹问题",
"createTime": 1437544304,
"id": 15,
"parentId": 12,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "物流配送",
"createTime": 1437544293,
"id": 14,
"parentId": 12,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "订单问题",
"createTime": 1437544209,
"id": 12,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
}
],
"message": "All Help Category List"
}获取所有二级分类
接口名：
/HelpCategoryRest/getSecondCategoryList
入参
{
}返回
{
"code": 200,
"data": [
{
"categoryName": "物流配送",
"createTime": 1437544293,
"id": 14,
"parentId": 12,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "包裹问题",
"createTime": 1437544304,
"id": 15,
"parentId": 12,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "常见支付问题",
"createTime": 1437544366,
"id": 17,
"parentId": 16,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "验货签收",
"createTime": 1437544382,
"id": 18,
"parentId": 16,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "售后服务",
"createTime": 1437544393,
"id": 19,
"parentId": 16,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "VIP制度说明",
"createTime": 1437544417,
"id": 21,
"parentId": 20,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "YOHO币",
"createTime": 1437544431,
"id": 22,
"parentId": 20,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "优惠券说明",
"createTime": 1437544461,
"id": 23,
"parentId": 20,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "订单修改",
"createTime": 1437547796,
"id": 25,
"parentId": 12,
"platform": "iphone,android",
"status": 1,
"updateTime": 1445320680
},
{
"categoryName": "第四个二级其他问题修改23",
"createTime": 1437552851,
"id": 29,
"parentId": 20,
"platform": "iphone,android",
"status": 1,
"updateTime": 1437555718
},
{
"categoryName": "测试新版重构内容添加",
"createTime": 1448868521,
"id": 45,
"parentId": 16,
"platform": "iphone,android,h5",
"status": 1,
"updateTime": 0
},
{
"categoryName": "钱军",
"createTime": 1456282636,
"id": 47,
"parentId": 12,
"platform": "iphone",
"status": 1,
"updateTime": 0
}
],
"message": "Second Help Category List"
}删除帮助分类
接口名：
/HelpCategoryRest/deleteHelpCategory
入参
{
"id":12,
"parentId": 12
}| 属性名称 | 类型 | 例子 | 说明 |
|---|---|---|---|
| id | int | 47 | 帮助内容记录ID |
| parentId | int | 12 | 父分类ID |
返回
{
"code": 200,
"message": "删除成功"
}
or
{
"code": 400,
"message": "Id is null"
}
or
{
"code": 500,
"message": "删除失败"
}根据parentId删除其分类下的id
接口名：
/HelpCategoryRest/deleteCategories
入参
{
"parentId": 12
}| 属性名称 | 类型 | 例子 | 说明 |
|---|---|---|---|
| parentId | int | 12 | 父分类ID |
返回
{
"code": 200,
"message": "删除成功"
}
or
{
"code": 500,
"message": "删除失败"
}帮助分类
接口名：
/HelpCategoryRest/getCategory
入参
{
"parentId": 13,
"platform":"iphone,android"
}| 属性名称 | 类型 | 例子 | 说明 |
|---|---|---|---|
| parentId | int | 12 | 父分类ID |
| platform | String | iphone,android | 显示平台 |
返回
{
"code": 200,
"data": [],
"message": "Help Category"
}