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 334 additions and 32 deletions
@@ -420,20 +420,38 @@ or @@ -420,20 +420,38 @@ or
420 } 420 }
421 ``` 421 ```
422 422
423 -## 根据ID获得帮助内容 423 +## 获取帮助内容总记录数
424 424
425 -> 接口名：`/HelpContentRest/getHelpContentById` 425 +> 接口名：`/HelpContentRest/getHelpContentCount`
426 426
427 ### 入参 427 ### 入参
  428 +无
  429 +---------------------
  430 +
  431 +### 返回
  432 +
428 ``` json 433 ``` json
429 { 434 {
430 - "id":44 435 + "code": 200,
  436 + "data": 22,
  437 + "message": "成功"
  438 +}
  439 +```
  440 +
  441 +## 根据分类ID查帮助内容
  442 +
  443 +> 接口名：`/HelpContentRest/getHelpContentByCategoryId`
  444 +
  445 +### 入参
  446 +``` json
  447 +{
  448 + "categoryId": 13
431 } 449 }
432 ``` 450 ```
433 ------------------------- 451 -------------------------
434 |属性名称|类型|例子|说明| 452 |属性名称|类型|例子|说明|
435 |--------|----|----|----| 453 |--------|----|----|----|
436 -|id|int|44|帮助内容记录ID| 454 +|categoryId|int|13|分类ID|
437 --------------------- 455 ---------------------
438 456
439 ### 返回 457 ### 返回
@@ -441,41 +459,183 @@ or @@ -441,41 +459,183 @@ or
441 ``` json 459 ``` json
442 { 460 {
443 "code": 200, 461 "code": 200,
444 - "data": { 462 + "data": [
  463 + {
445 "categoryId": 13, 464 "categoryId": 13,
446 - "content": "如订单未选择发票需要补寄，请您联系有货客服，我们可以为您补开三个自然月内订单的发票，但是需运费到付。",  
447 - "createTime": 1455438073,  
448 - "id": 44,  
449 - "platform": [  
450 - "iphone",  
451 - "android",  
452 - "h5" 465 + "content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
  466 + "createTime": 1437545220,
  467 + "id": 1,
  468 + "platform": "iphone,android",
  469 + "status": 1,
  470 + "title": "取消订单",
  471 + "updateTime": 1437548510
  472 + },
  473 + {
  474 + "categoryId": 13,
  475 + "content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
  476 + "createTime": 1437562767,
  477 + "id": 10,
  478 + "platform": "iphone,android",
  479 + "status": 1,
  480 + "title": "订单内容的修改",
  481 + "updateTime": 0
  482 + },
  483 + {
  484 + "categoryId": 13,
  485 + "content": "因为网络问题，信息更新有所延迟，导致无法显示，请您保持网络顺畅情况下，重新登录进入再查看。",
  486 + "createTime": 1437562792,
  487 + "id": 11,
  488 + "platform": "iphone,android",
  489 + "status": 1,
  490 + "title": "下单后看不到订单",
  491 + "updateTime": 0
  492 + },
  493 + {
  494 + "categoryId": 13,
  495 + "content": "订单生成后无法修改收货人信息，请您联系有货客服处理。",
  496 + "createTime": 1437562842,
  497 + "id": 13,
  498 + "platform": "iphone,android",
  499 + "status": 1,
  500 + "title": "修改订单地址/电话",
  501 + "updateTime": 0
  502 + },
  503 + {
  504 + "categoryId": 13,
  505 + "content": "3",
  506 + "createTime": 1437566035,
  507 + "id": 16,
  508 + "platform": "iphone,android",
  509 + "status": 1,
  510 + "title": "2",
  511 + "updateTime": 0
  512 + },
  513 + {
  514 + "categoryId": 13,
  515 + "content": "4",
  516 + "createTime": 1437566047,
  517 + "id": 17,
  518 + "platform": "iphone,android",
  519 + "status": 1,
  520 + "title": "3",
  521 + "updateTime": 0
  522 + }
453 ], 523 ],
454 - "title": "补开发票",  
455 - "updateTime": 1455438842 524 + "message": "Help Content List by CategoryId"
  525 +}
  526 +or
  527 +{
  528 + "code":400
  529 + "message":"分类ID无效"
  530 +}
  531 +```
  532 +
  533 +## 根据平台查帮助内容
  534 +
  535 +> 接口名：`/HelpContentRest/getHelpContentByPlatform`
  536 +
  537 +### 入参
  538 +``` json
  539 +{
  540 + "platform": "iphone,android"
  541 +}
  542 +```
  543 +-------------------------
  544 +|属性名称|类型|例子|说明|
  545 +|--------|----|----|----|
  546 +|platform|String|iphone,android|显示平台|
  547 +---------------------
  548 +
  549 +### 返回
  550 +
  551 +``` json
  552 +{
  553 + "code": 200,
  554 + "data": [
  555 + {
  556 + "categoryId": 13,
  557 + "content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
  558 + "createTime": 1437545220,
  559 + "id": 1,
  560 + "platform": "iphone,android",
  561 + "status": 1,
  562 + "title": "取消订单",
  563 + "updateTime": 1437548510
456 }, 564 },
457 - "message": "Help Content" 565 + {
  566 + "categoryId": 13,
  567 + "content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
  568 + "createTime": 1437562767,
  569 + "id": 10,
  570 + "platform": "iphone,android",
  571 + "status": 1,
  572 + "title": "订单内容的修改",
  573 + "updateTime": 0
  574 + },
  575 + {
  576 + "categoryId": 13,
  577 + "content": "因为网络问题，信息更新有所延迟，导致无法显示，请您保持网络顺畅情况下，重新登录进入再查看。",
  578 + "createTime": 1437562792,
  579 + "id": 11,
  580 + "platform": "iphone,android",
  581 + "status": 1,
  582 + "title": "下单后看不到订单",
  583 + "updateTime": 0
  584 + },
  585 + {
  586 + "categoryId": 13,
  587 + "content": "订单生成后无法修改收货人信息，请您联系有货客服处理。",
  588 + "createTime": 1437562842,
  589 + "id": 13,
  590 + "platform": "iphone,android",
  591 + "status": 1,
  592 + "title": "修改订单地址/电话",
  593 + "updateTime": 0
  594 + },
  595 + {
  596 + "categoryId": 13,
  597 + "content": "3",
  598 + "createTime": 1437566035,
  599 + "id": 16,
  600 + "platform": "iphone,android",
  601 + "status": 1,
  602 + "title": "2",
  603 + "updateTime": 0
  604 + },
  605 + {
  606 + "categoryId": 13,
  607 + "content": "4",
  608 + "createTime": 1437566047,
  609 + "id": 17,
  610 + "platform": "iphone,android",
  611 + "status": 1,
  612 + "title": "3",
  613 + "updateTime": 0
  614 + }
  615 + ],
  616 + "message": "Help Content List by CategoryId"
458 } 617 }
  618 +or
459 { 619 {
460 "code":400 620 "code":400
461 - "message":"Id is null" 621 + "message":"分类ID无效"
462 } 622 }
463 ``` 623 ```
464 624
465 -## 根据ID获得帮助内容 625 +## 根据分类ID查帮助内容
466 626
467 -> 接口名：`/HelpContentRest/getHelpContentById` 627 +> 接口名：`/HelpContentRest/getHelpContentByCategoryId`
468 628
469 ### 入参 629 ### 入参
470 ``` json 630 ``` json
471 { 631 {
472 - "id":44 632 + "categoryId": 13
473 } 633 }
474 ``` 634 ```
475 ------------------------- 635 -------------------------
476 |属性名称|类型|例子|说明| 636 |属性名称|类型|例子|说明|
477 |--------|----|----|----| 637 |--------|----|----|----|
478 -|id|int|44|帮助内容记录ID| 638 +|categoryId|int|13|分类ID|
479 --------------------- 639 ---------------------
480 640
481 ### 返回 641 ### 返回
@@ -483,24 +643,166 @@ or @@ -483,24 +643,166 @@ or
483 ``` json 643 ``` json
484 { 644 {
485 "code": 200, 645 "code": 200,
486 - "data": { 646 + "data": [
  647 + {
487 "categoryId": 13, 648 "categoryId": 13,
488 - "content": "如订单未选择发票需要补寄，请您联系有货客服，我们可以为您补开三个自然月内订单的发票，但是需运费到付。",  
489 - "createTime": 1455438073,  
490 - "id": 44,  
491 - "platform": [  
492 - "iphone",  
493 - "android",  
494 - "h5" 649 + "content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
  650 + "createTime": 1437545220,
  651 + "id": 1,
  652 + "platform": "iphone,android",
  653 + "status": 1,
  654 + "title": "取消订单",
  655 + "updateTime": 1437548510
  656 + },
  657 + {
  658 + "categoryId": 13,
  659 + "content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
  660 + "createTime": 1437562767,
  661 + "id": 10,
  662 + "platform": "iphone,android",
  663 + "status": 1,
  664 + "title": "订单内容的修改",
  665 + "updateTime": 0
  666 + },
  667 + {
  668 + "categoryId": 13,
  669 + "content": "因为网络问题，信息更新有所延迟，导致无法显示，请您保持网络顺畅情况下，重新登录进入再查看。",
  670 + "createTime": 1437562792,
  671 + "id": 11,
  672 + "platform": "iphone,android",
  673 + "status": 1,
  674 + "title": "下单后看不到订单",
  675 + "updateTime": 0
  676 + },
  677 + {
  678 + "categoryId": 13,
  679 + "content": "订单生成后无法修改收货人信息，请您联系有货客服处理。",
  680 + "createTime": 1437562842,
  681 + "id": 13,
  682 + "platform": "iphone,android",
  683 + "status": 1,
  684 + "title": "修改订单地址/电话",
  685 + "updateTime": 0
  686 + },
  687 + {
  688 + "categoryId": 13,
  689 + "content": "3",
  690 + "createTime": 1437566035,
  691 + "id": 16,
  692 + "platform": "iphone,android",
  693 + "status": 1,
  694 + "title": "2",
  695 + "updateTime": 0
  696 + },
  697 + {
  698 + "categoryId": 13,
  699 + "content": "4",
  700 + "createTime": 1437566047,
  701 + "id": 17,
  702 + "platform": "iphone,android",
  703 + "status": 1,
  704 + "title": "3",
  705 + "updateTime": 0
  706 + }
495 ], 707 ],
496 - "title": "补开发票",  
497 - "updateTime": 1455438842 708 + "message": "Help Content List by CategoryId"
  709 +}
  710 +or
  711 +{
  712 + "code":400
  713 + "message":"分类ID无效"
  714 +}
  715 +```
  716 +
  717 +## 帮助内容
  718 +
  719 +> 接口名：`/HelpContentRest/getHelpContentByCategoryId`
  720 +
  721 +### 入参
  722 +``` json
  723 +{
  724 + "categoryId": 13
  725 +}
  726 +```
  727 +-------------------------
  728 +|属性名称|类型|例子|说明|
  729 +|--------|----|----|----|
  730 +|categoryId|int|13|分类ID|
  731 +---------------------
  732 +
  733 +### 返回
  734 +
  735 +``` json
  736 +{
  737 + "code": 200,
  738 + "data": [
  739 + {
  740 + "categoryId": 13,
  741 + "content": "在线支付订单未付款2小时内会自动取消，付款成功后需联系有货客服取消订单，货到付款订单未发货前可以进入“我的订单”自行取消订单。",
  742 + "createTime": 1437545220,
  743 + "id": 1,
  744 + "platform": "iphone,android",
  745 + "status": 1,
  746 + "title": "取消订单",
  747 + "updateTime": 1437548510
498 }, 748 },
499 - "message": "Help Content" 749 + {
  750 + "categoryId": 13,
  751 + "content": "目前暂不支持订单修改功能，请您联系有货客服为您处理。",
  752 + "createTime": 1437562767,
  753 + "id": 10,
  754 + "platform": "iphone,android",
  755 + "status": 1,
  756 + "title": "订单内容的修改",
  757 + "updateTime": 0
  758 + },
  759 + {
  760 + "categoryId": 13,
  761 + "content": "因为网络问题，信息更新有所延迟，导致无法显示，请您保持网络顺畅情况下，重新登录进入再查看。",
  762 + "createTime": 1437562792,
  763 + "id": 11,
  764 + "platform": "iphone,android",
  765 + "status": 1,
  766 + "title": "下单后看不到订单",
  767 + "updateTime": 0
  768 + },
  769 + {
  770 + "categoryId": 13,
  771 + "content": "订单生成后无法修改收货人信息，请您联系有货客服处理。",
  772 + "createTime": 1437562842,
  773 + "id": 13,
  774 + "platform": "iphone,android",
  775 + "status": 1,
  776 + "title": "修改订单地址/电话",
  777 + "updateTime": 0
  778 + },
  779 + {
  780 + "categoryId": 13,
  781 + "content": "3",
  782 + "createTime": 1437566035,
  783 + "id": 16,
  784 + "platform": "iphone,android",
  785 + "status": 1,
  786 + "title": "2",
  787 + "updateTime": 0
  788 + },
  789 + {
  790 + "categoryId": 13,
  791 + "content": "4",
  792 + "createTime": 1437566047,
  793 + "id": 17,
  794 + "platform": "iphone,android",
  795 + "status": 1,
  796 + "title": "3",
  797 + "updateTime": 0
  798 + }
  799 + ],
  800 + "message": "Help Content List by CategoryId"
500 } 801 }
  802 +or
501 { 803 {
502 "code":400 804 "code":400
503 - "message":"Id is null" 805 + "message":"分类ID无效"
504 } 806 }
505 ``` 807 ```
506 808