Blame view

inferface-document/cms/help_content.md 22.3 KB
qianjun authored
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
# 帮助内容接口服务定义
---------------------

## 添加帮助内容

> 接口名:`/HelpContentRest/addHelpContent`

### 入参
``` json
{
 "title":"补开发票",
 "categoryId":13,
 "content":"如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
 "platform":"iphone,android"
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|title|String|补开发票|帮助标题|
|categoryId|int|13|分类ID|
|content|String|如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。|帮助内容|
|platform|String|iphone,android|显示平台|
---------------------

### 返回

``` json
{
  "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"
}
```

qianjun authored
56 57 58
## 修改帮助内容

> 接口名:`/HelpContentRest/updateHelpContent`
qianjun authored
59 60

### 入参
qianjun authored
61
``` json
qianjun authored
62
{
qianjun authored
63 64 65 66 67
 "id":44,
 "title":"补开发票",
 "categoryId":13,
 "platform":"iphone,android,h5",
 "content":"如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。"
qianjun authored
68 69 70 71 72
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
qianjun authored
73 74 75 76 77 78
|id|int|44|帮助内容记录ID|
|title|String|补开发票|帮助标题|
|categoryId|int|13|分类ID|
|content|String|如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。|帮助内容|
|platform|String|iphone,android|显示平台|
---------------------
qianjun authored
79 80 81

### 返回
qianjun authored
82
``` json
qianjun authored
83
{
qianjun authored
84 85
  "code": 200,
  "message": "Update Help Content Success"
qianjun authored
86 87
}
{
qianjun authored
88 89
  "code":400
  "message":"Id is null"
qianjun authored
90 91
}
{
qianjun authored
92 93
  "code":400
  "message":"帮助标题不能为空"
qianjun authored
94 95
}
{
qianjun authored
96 97
  "code":400
  "message":"分类ID无效"
qianjun authored
98 99 100
}
{
  "code":400
qianjun authored
101
  "message":"内容无效"
qianjun authored
102 103
}
{
qianjun authored
104 105
  "code":400
  "message":"显示平台无效"
qianjun authored
106 107 108
}
{
  "code":500
qianjun authored
109
  "message":"Upodate Help Content Fail"
qianjun authored
110 111 112
}
```
qianjun authored
113
## 根据ID获得帮助内容
qianjun authored
114
qianjun authored
115
> 接口名:`/HelpContentRest/getHelpContentById`
qianjun authored
116 117

### 入参
qianjun authored
118 119 120
``` json
{
 "id":44
qianjun authored
121 122 123 124 125
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
qianjun authored
126 127
|id|int|44|帮助内容记录ID|
---------------------
qianjun authored
128 129 130

### 返回
qianjun authored
131
``` json
qianjun authored
132
{
qianjun authored
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
  "code": 200,
  "data": {
    "categoryId": 13,
    "content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
    "createTime": 1455438073,
    "id": 44,
    "platform": [
      "iphone",
      "android",
      "h5"
    ],
    "title": "补开发票",
    "updateTime": 1455438842
  },
  "message": "Help Content"
qianjun authored
148 149
}
{
qianjun authored
150 151
  "code":400
  "message":"Id is null"
qianjun authored
152 153
}
```
qianjun authored
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
## 获取所有帮助内容

> 接口名:`/HelpContentRest/getAllHelpContent`

### 入参
``` json
{
    "categoryId":13,
    "platform":"iphone,android"
}
or
{
    "categoryId":13,
}
or
{
    "platform":"iphone,android"
}
or
{ }
```
注意:如果不传入参数,必须传入`{}`
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|categoryId|int|13|分类ID(可选)|
|platform|String|iphone,android|显示平台(可选)|
---------------------

### 返回

``` json
{
  "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"
}
```
qianjun authored
263
## 删除帮助内容
qianjun authored
264
qianjun authored
265
> 接口名:`/HelpContentRest/deleteHelpContent`
qianjun authored
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283

### 入参
``` json
{
 "id":44
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|id|int|44|帮助内容记录ID|
---------------------

### 返回

``` json
{
  "code": 200,
qianjun authored
284
  "message": "删除成功"
qianjun authored
285
}
qianjun authored
286
or
qianjun authored
287
{
qianjun authored
288 289 290 291 292 293 294
  "code": 400,
  "message": "Id is null"
}
or
{
  "code": 500,
  "message": "删除失败"
qianjun authored
295 296 297
}
```
qianjun authored
298
## 分页显示帮助内容
qianjun authored
299
qianjun authored
300
> 接口名:`/HelpContentRest/getHelpContentList`
qianjun authored
301 302 303 304

### 入参
``` json
{
qianjun authored
305 306
 "page":2,
 "size":12  
qianjun authored
307 308 309 310 311
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
qianjun authored
312 313
|page|int|2|第几页(可选) 默认为1|
|size|int|12|每页条数(可选)默认为10|
qianjun authored
314 315 316 317 318 319 320 321
---------------------

### 返回

``` json
{
  "code": 200,
  "data": {
qianjun authored
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
    "list": [
      {
        "categoryId": 0,
        "content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "订单内容的修改",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "优惠券是有货线上品牌商城针对不同品牌或商品向消费者发送的虚拟券,优惠券可直接用于指定品牌或商品消费,不可转让他人,不可兑换为现金。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "什么是优惠券?",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "Yoho币是有货商城全场针对不同商品向已激活用户返还的虚拟购物币。Yoho!币可直接用于有货线上购物使用,不可转让他人,不可兑换为现金。使用YOHO币支付的金额将不计入消费金额用以计算返还金额。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "Yoho币是什么,有什么用?",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "银卡会员需年度累计消费满600元,金卡会员需年度累计消费满2000元,白金会员需年度累计消费满5000元。年度指连续的365天内(数字年),而非2011,2012这样的自然年。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "消费多少可以成为银卡会员、金卡会员、白金会员?",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "您可进入“我的订单”,点击”确认收货”后,申请退换货,按页面提示填写相关信息,提交申请。我们会在24小时内以短信或电话的方式告知您审核结果,审核通过后,请您将商品连同发货单一并寄回,请您寄回时不要选择平邮或到付。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "如何办理退换货",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "有货与配送公司签订先验货后签收协议,请在配送人员还在场的情况下,当面验收您的商品,货到付款订单可以开箱验货但是未签收情况下不能试穿。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "可以开箱验货吗",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "浦发,深发,民生等银行只要客户设了密码,都是不可以进行交易的;工,农,建等全国性银行中,只有工行肯定是不能交易,别的银行是可以的。如在支付中有任何疑问,请联系有货客服为您处理",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "为什么信用卡无法支付",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "补开发票",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "您可进入“我的订单”中查询订单状态,有货会在订单审核通过后24小时内为您发出包裹。(温馨提示:预售商品发货时间以商品页面标注为准)。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "发货时间",
        "updateTime": 0
      },
      {
        "categoryId": 0,
        "content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。",
        "createTime": 0,
        "id": 0,
        "platform": "iphone,android",
        "title": "取消订单",
        "updateTime": 0
      }
qianjun authored
413
    ],
qianjun authored
414 415 416 417
    "page": 2,
    "size": 12,
    "total": 0,
    "totalPage": 0
qianjun authored
418
  },
qianjun authored
419
  "message": "Help Content List"
qianjun authored
420 421 422
}
```
qianjun authored
423
## 获取帮助内容总记录数
qianjun authored
424
qianjun authored
425
> 接口名:`/HelpContentRest/getHelpContentCount`
qianjun authored
426 427

### 入参
qianjun authored
428 429 430 431 432

---------------------

### 返回
qianjun authored
433 434
``` json
{
qianjun authored
435 436 437 438 439 440 441 442 443 444 445 446 447 448
  "code": 200,
  "data": 22,
  "message": "成功"
}
```

## 根据分类ID查帮助内容

> 接口名:`/HelpContentRest/getHelpContentByCategoryId`

### 入参
``` json
{
 "categoryId": 13
qianjun authored
449 450 451 452 453
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
qianjun authored
454
|categoryId|int|13|分类ID|
qianjun authored
455 456 457 458 459 460 461
---------------------

### 返回

``` json
{
  "code": 200,
qianjun authored
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
  "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"
qianjun authored
525
}
qianjun authored
526
or
qianjun authored
527 528
{
  "code":400
qianjun authored
529
  "message":"分类ID无效"
qianjun authored
530 531 532
}
```
qianjun authored
533
## 根据平台查帮助内容
qianjun authored
534
qianjun authored
535
> 接口名:`/HelpContentRest/getHelpContentByPlatform`
qianjun authored
536 537 538 539

### 入参
``` json
{
qianjun authored
540
 "platform": "iphone,android"
qianjun authored
541 542 543 544 545
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
qianjun authored
546
|platform|String|iphone,android|显示平台|
qianjun authored
547 548 549 550 551 552 553
---------------------

### 返回

``` json
{
  "code": 200,
qianjun authored
554 555 556 557 558 559 560 561 562 563 564 565
  "data": [
    {
      "categoryId": 13,
      "content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。",
      "createTime": 1437545220,
      "id": 1,
      "platform": "iphone,android",
      "status": 1,
      "title": "取消订单",
      "updateTime": 1437548510
    },
    {
qianjun authored
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
      "categoryId": 14,
      "content": "您可进入“我的订单”中查询订单状态,有货会在订单审核通过后24小时内为您发出包裹。(温馨提示:预售商品发货时间以商品页面标注为准)。",
      "createTime": 1437546597,
      "id": 2,
      "platform": "iphone,android",
      "status": 1,
      "title": "发货时间",
      "updateTime": 1437548685
    },
    {
      "categoryId": 15,
      "content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
      "createTime": 1437546640,
      "id": 3,
      "platform": "iphone,android",
      "status": 1,
      "title": "补开发票",
      "updateTime": 1437548679
    },
    {
      "categoryId": 17,
      "content": "浦发,深发,民生等银行只要客户设了密码,都是不可以进行交易的;工,农,建等全国性银行中,只有工行肯定是不能交易,别的银行是可以的。如在支付中有任何疑问,请联系有货客服为您处理",
      "createTime": 1437546674,
      "id": 4,
      "platform": "iphone,android",
      "status": 1,
      "title": "为什么信用卡无法支付",
      "updateTime": 1437548673
    },
    {
      "categoryId": 18,
      "content": "有货与配送公司签订先验货后签收协议,请在配送人员还在场的情况下,当面验收您的商品,货到付款订单可以开箱验货但是未签收情况下不能试穿。",
      "createTime": 1437546710,
      "id": 5,
      "platform": "iphone,android",
      "status": 1,
      "title": "可以开箱验货吗",
      "updateTime": 1437548665
    },
    {
      "categoryId": 19,
      "content": "您可进入“我的订单”,点击”确认收货”后,申请退换货,按页面提示填写相关信息,提交申请。我们会在24小时内以短信或电话的方式告知您审核结果,审核通过后,请您将商品连同发货单一并寄回,请您寄回时不要选择平邮或到付。",
      "createTime": 1437546751,
      "id": 6,
      "platform": "iphone,android",
      "status": 1,
      "title": "如何办理退换货",
      "updateTime": 1437548659
    },
    {
      "categoryId": 21,
      "content": "银卡会员需年度累计消费满600元,金卡会员需年度累计消费满2000元,白金会员需年度累计消费满5000元。年度指连续的365天内(数字年),而非2011,2012这样的自然年。",
      "createTime": 1437546777,
      "id": 7,
      "platform": "iphone,android",
      "status": 1,
      "title": "消费多少可以成为银卡会员、金卡会员、白金会员?",
      "updateTime": 1437548651
    },
    {
      "categoryId": 22,
      "content": "Yoho币是有货商城全场针对不同商品向已激活用户返还的虚拟购物币。Yoho!币可直接用于有货线上购物使用,不可转让他人,不可兑换为现金。使用YOHO币支付的金额将不计入消费金额用以计算返还金额。",
      "createTime": 1437546798,
      "id": 8,
      "platform": "iphone,android",
      "status": 1,
      "title": "Yoho币是什么,有什么用?",
      "updateTime": 1437548645
    },
    {
      "categoryId": 23,
      "content": "优惠券是有货线上品牌商城针对不同品牌或商品向消费者发送的虚拟券,优惠券可直接用于指定品牌或商品消费,不可转让他人,不可兑换为现金。",
      "createTime": 1437546819,
      "id": 9,
      "platform": "iphone,android",
      "status": 1,
      "title": "什么是优惠券?",
      "updateTime": 1437552970
    },
    {
qianjun authored
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
      "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
    },
    {
qianjun authored
666 667 668 669 670 671 672 673 674 675
      "categoryId": 14,
      "content": "货到付款订单提交后为待审核状态的正常的,我们会在您成功下单后24小时内审核您的订单。",
      "createTime": 1437562820,
      "id": 12,
      "platform": "iphone,android",
      "status": 1,
      "title": "订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核",
      "updateTime": 1437815593
    },
    {
qianjun authored
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
      "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
qianjun authored
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
    },
    {
      "categoryId": 17,
      "content": "测试",
      "createTime": 1438219772,
      "id": 35,
      "platform": "iphone,android",
      "status": 1,
      "title": "这个是常见支付的问题",
      "updateTime": 0
    },
    {
      "categoryId": 22,
      "content": "测试",
      "createTime": 1438219938,
      "id": 36,
      "platform": "iphone,android",
      "status": 1,
      "title": "这是yoho币的问题",
      "updateTime": 0
qianjun authored
724 725 726
    }
  ],
  "message": "Help Content List by CategoryId"
qianjun authored
727
}
qianjun authored
728
or
qianjun authored
729 730
{
  "code":400
qianjun authored
731
  "message":"显示平台无效"
qianjun authored
732 733 734
}
```
qianjun authored
735
## 帮助列表
qianjun authored
736
qianjun authored
737
> 接口名:`/HelpContentRest/getHelp`
qianjun authored
738 739 740 741

### 入参
``` json
{
qianjun authored
742 743 744 745 746 747
    "categoryId":13,
    "platform":"iphone,android"
}
or
{
    "categoryId":13,
qianjun authored
748 749 750 751 752 753
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|categoryId|int|13|分类ID|
qianjun authored
754
|platform|String|iphone,android|显示平台(可选)默认h5|
qianjun authored
755 756 757 758 759 760
---------------------

### 返回

``` json
{
qianjun authored
761 762
    "categoryId":13,
    "platform":"iphone,android"
qianjun authored
763 764 765 766
}
or
{
  "code":400
qianjun authored
767
  "message":"帮助分类不能为空"
qianjun authored
768 769 770 771 772
}
```

## 帮助内容
qianjun authored
773
> 接口名:`/HelpContentRest/getHelpContent`
qianjun authored
774 775 776 777

### 入参
``` json
{
qianjun authored
778
 "id": 42
qianjun authored
779 780 781 782 783
}
```
-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
qianjun authored
784
|id|int|42|帮助内容记录ID|
qianjun authored
785 786 787 788 789 790 791
---------------------

### 返回

``` json
{
  "code": 200,
qianjun authored
792 793 794 795 796 797 798 799 800 801 802 803
  "data": {
    "categoryId": 14,
    "content": "这个是物流问题",
    "createTime": 1449038392,
    "id": 42,
    "platform": [
      "h5"
    ],
    "title": "物流问题",
    "updateTime": 0
  },
  "message": "帮助内容"
qianjun authored
804 805 806 807
}
or
{
  "code":400
qianjun authored
808 809 810 811 812 813
  "message":"请选择要查看的帮助"
}
or
{
  "code":400
  "message":"内容不存在"
qianjun authored
814 815
}
```
qianjun authored
816
qianjun authored
817