帮助分类接口服务定义
添加帮助分类
接口名：/HelpCategoryRest/addCategory
入参
{
"categoryName":"订单问题",
"parentId":0,
"platform":"iphone,android"
}
| 属性名称 |
类型 |
例子 |
说明 |
是否必填 |
长度限制 |
| categoryName |
String |
订单问题 |
分类名称 |
是 |
无 |
| parentId |
int |
0 |
父分类ID |
是 |
无 |
| platform |
String |
iphone,android |
显示平台 |
是 |
无 |
1. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<insert id="insert" parameterType="com.yohobuy.platform.dal.cms.model.HelpCategory" >
insert into help_category (category_name, parent_id,platform, create_time)
values (#{categoryName,jdbcType=VARCHAR}, #{parentId,jdbcType=SMALLINT},
#{platform,jdbcType=VARCHAR}, UNIX_TIMESTAMP())
</insert>
错误编码
| 错误码code |
消息 |
说明 |
| 400 |
分类名称不能为空 |
|
| 400 |
分类ID无效 |
|
| 400 |
显示平台无效 |
|
| 500 |
添加帮助分类失败 |
|
| 200 |
添加帮助分类成功 |
|
返回
{
"code": 200,
"message": "添加帮助分类成功"
}
修改帮助分类
接口名：/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 |
显示平台 |
是 |
无 |
1. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<update id="updateByPrimaryKey" parameterType="com.yohobuy.platform.dal.cms.model.HelpCategory" >
update help_category
set category_name = #{categoryName,jdbcType=VARCHAR},
parent_id = #{parentId,jdbcType=SMALLINT},
platform = #{platform,jdbcType=VARCHAR},
update_time = UNIX_TIMESTAMP()
where id = #{id,jdbcType=SMALLINT}
</update>
错误编码
| 错误码code |
消息 |
说明 |
| 400 |
Id为空 |
|
| 400 |
分类名称不能为空 |
|
| 400 |
分类ID无效 |
|
| 400 |
显示平台无效 |
|
| 500 |
添加帮助分类失败 |
|
| 200 |
添加帮助分类成功 |
|
返回
{
"code": 200,
"message": "更新帮助分类成功"
}
根据ID获得帮助分类
接口名：/HelpCategoryRest/getHelpCategoryById
入参
{
"id":46
}
| 属性名称 |
类型 |
例子 |
说明 |
是否必填 |
长度限制 |
| id |
int |
46 |
帮助分类记录ID |
是 |
无 |
1. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Short" >
select
<include refid="Base_Column_List" />
from help_category
where id = #{id,jdbcType=SMALLINT} and status=1
</select>
错误编码
| 错误码code |
消息 |
说明 |
| 400 |
Id为空 |
|
| 200 |
帮助分类 |
|
返回
{
"code": 200,
"data": {
"categoryName": "订单问题2期项目",
"createTime": 1456281715,
"id": 46,
"parentId": 0,
"platform": [
"iphone",
"android"
],
"updateTime": 1456283370
},
"message": "帮助分类"
}
根据父id获取帮助分类
接口名：/HelpCategoryRest/getCategoryListByPid
入参
{
"parentId":0
}
| 属性名称 |
类型 |
例子 |
说明 |
是否必填 |
长度限制 |
| parentId |
int |
0 |
父分类ID |
是 |
无 |
1. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<select id="selectCategoryListByPid" resultMap="BaseResultMap" parameterType="java.lang.Integer" >
select
<include refid="Base_Column_List" />
from help_category
where parent_id = #{parentId,jdbcType=INTEGER} and status=1
</select>
错误编码
| 错误码code |
消息 |
说明 |
| 400 |
分类ID无效 |
|
| 200 |
帮助分类列表 |
|
返回
{
"code": 200,
"data": [
{
"categoryName": "订单问题",
"createTime": 1437544209,
"id": 12,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
},
{
"categoryName": "订单问题",
"createTime": 1456284113,
"id": 48,
"parentId": 0,
"platform": "iphone,android",
"status": 1,
"updateTime": 0
}
],
"message": "帮助分类列表"
}
获取所有帮助分类
接口名：/HelpCategoryRest/getAllHelpCategory
入参
无
1. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<select id="selectAllHelpCategory" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from help_category
where status=1
order by id DESC
</select>
错误编码
| 错误码code |
消息 |
说明 |
| 200 |
所有帮助分类列表 |
|
返回
{
"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
}
],
"message": "所有帮助分类列表"
}
获取所有二级分类
接口名：/HelpCategoryRest/getSecondCategoryList
入参
无
1. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<select id="selectSecondCategoryList" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from help_category
where status=1 and parent_id>0
</select>
错误编码
| 错误码code |
消息 |
说明 |
| 200 |
二级分类帮助分类列表 |
|
返回
{
"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
}
],
"message": "二级分类帮助分类列表"
}
删除帮助分类
接口名：/HelpCategoryRest/deleteHelpCategory
入参
{
"id":12,
"parentId": 12
}
| 属性名称 |
类型 |
例子 |
说明 |
是否必填 |
长度限制 |
| id |
int |
47 |
帮助内容记录ID |
是 |
无 |
| parentId |
int |
12 |
父分类ID |
是 |
无 |
1. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<delete id="deleteHelpCategoryById" parameterType="java.lang.Integer" >
update help_category set status=2
where id = #{id,jdbcType=INTEGER}
</delete>
注意：逻辑删除
2. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<delete id="deleteHelpCategoryByPid" parameterType="java.lang.Integer" >
update help_category set status=2
where parent_id = #{parentId,jdbcType=INTEGER} and status=1
</delete>
注意：逻辑删除
错误编码
| 错误码code |
消息 |
说明 |
| 400 |
Id为空 |
|
| 500 |
删除失败 |
|
| 200 |
删除成功 |
|
返回
{
"code": 200,
"message": "删除成功"
}
根据parentId删除其分类下的id
接口名：/HelpCategoryRest/deleteCategories
入参
{
"parentId": 12
}
| 属性名称 |
类型 |
例子 |
说明 |
是否必填 |
长度限制 |
| parentId |
int |
12 |
父分类ID |
是 |
无 |
1. 对应SQL的操作库表（数据库 yhb_operations, 表 help_category）
<delete id="deleteHelpCategoryByPid" parameterType="java.lang.Integer" >
update help_category set status=2
where parent_id = #{parentId,jdbcType=INTEGER} and status=1
</delete>
注意：逻辑删除
错误编码
| 错误码code |
消息 |
说明 |
| 500 |
删除失败 |
|
| 200 |
删除成功 |
|
返回
{
"code": 200,
"message": "删除成功"
}
帮助分类（没用到）
接口名：/HelpCategoryRest/getCategory
入参
{
"parentId": 13,
"platform":"iphone,android"
}
| 属性名称 |
类型 |
例子 |
说明 |
| parentId |
int |
12 |
父分类ID |
| platform |
String |
iphone,android |
显示平台 |
返回
{
"code": 200,
"data": [],
"message": "Help Category"
}
