Changes between Version 27 and Version 28 of pclady_modern1.0.0_api


Ignore:
Timestamp:
03/31/2016 05:56:37 PM (10 years ago)
Author:
caomenglin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • pclady_modern1.0.0_api

    v27 v28  
    117117> 根据需求文档返回对应的节点[[BR]] 
    118118> 由于需要查询正在直播的视频，先不考虑缓存[[BR]] 
     119> teacher和data节点由mrobot分别调用老师列表接口和首页热门课程组成。后端不需要返回[[BR]] 
     120> 分页查询的参数只有mrobot用到[[BR]] 
    119121 
    120122**缓存时间** 
    … …  
    137139 
    138140||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| 
     141||pageNo||页数，morbot用到，后端接口不需要||int||1||是|| 
     142||pageSize||页面大小||int||10||是|| 
    139143 
    140144**返回** 
    … …  
    191195    ], 
    192196    "teacher":{ 
    193         "hotTeacher":[ 
     197        [ 
    194198                { 
    195             "techId": 111, 
    196             "techJobName": "××御用化妆师", 
    197             "techNickName": "老师姓名", 
    198             "techIconUrl": "http://img.pconline.com.cn/7.jpg", 
    199             "techType": 1 
    200         } 
    201         ] 
    202         "otherTeacher": [ 
    203         { 
    204199            "techId": 111, 
    205200            "techJobName": "××御用化妆师", 
    … …  
    244239        } 
    245240    ] 
    246     "hotVideo": [ 
     241    "data": [ 
    247242        { 
    248243            "courseId": 11, 
    … …  
    274269[[BR]] 
    275270 
     271=== 2.2首页热门课程 === 
     272开发环境：http://dev15.pclady.com.cn:8004/app/hotCourseList.jsp [[BR]] 
     273线上环境：http://modern.pclady.com.cn/app/hotCourseList.jsp [[BR]] 
     274 
     275**说明** 
     276 
     277> 根据需求文档返回对应的节点[[BR]] 
     278 
     279**缓存时间** 
     280 
     281>15 
     282 
     283**提交方式** 
     284 
     285> GET 
     286 
     287**是否登录** 
     288 
     289> 否 
     290 
     291**数据来源** 
     292 
     293>摩登后台 
     294 
     295**参数** 
     296 
     297||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| 
     298||pageNo||页数||int||1||是|| 
     299||pageSize||页面大小||int||10||是|| 
     300 
     301**返回** 
     302 
     303{{{#!java 
     304{ 
     305    "status": 0, 
     306    "msg": "请求成功", 
     307    "data": [ 
     308        { 
     309            "courseId": 11, 
     310            "liveTime": "6'33''", 
     311            "imageUrl": "http://img.pconline.com.cn/7.jpg", 
     312            "techId": 1111, 
     313            "techJobName": "××御用化妆师", 
     314            "techNickName": "老师姓名", 
     315            "techIconUrl": "http://img.pconline.com.cn/7.jpg", 
     316            "techType": 1, 
     317            "title": "课程标题", 
     318            "watchTotal": 100 
     319        } 
     320    ] 
     321} 
     322 
     323}}} 
     324**返回参数说明** 
     325||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     326||= typeName =||= 直播课:liveCourse，视频课程:videoCourse，老师:teach，标签:tagInfo，外链:webview =||= focus =||= 焦点图节点，返回5张焦点图 =|| 
     327||= liveType =||= 1:直播,2:预告 =||=imageUrl =||= liveVideo节点中为封面图 =|| 
     328||= techID =||= 老师ID =||=techJobName =||= 头衔 =|| 
     329||= startTime =||= 如果为预告，要返回开始时间 =||=watchTotal =||= 如果是直播，返回观看人数 =|| 
     330||= techIconUrl =||= 老师等级icon =||=techType =||= 老师类型，1：老师，2：达人 =|| 
     331||= teacher =||= 老师推荐节点，7条 =||=chosenVideo =||= 精选直播课节点，6条 =|| 
     332||= liveTime =||= 视频时长 =||=tag =||= 标签，最多三个 =|| 
     333||= hotVideo =||= 热点视频节点 =||=tag =||= 标签，最多三个 =|| 
     334||= makeupCourse =||= 化妆课程 =||=hotTeacher =||= 人气都是 =|| 
     335[[BR]] 
    276336 
    277337---------- 
    … …  
    465525            } 
    466526        ], 
    467         "watchIng": [ 
    468             "11", 
     527        "followUserIdList": [ 
     528            "111", 
    469529            "222" 
    470530        ] 
    … …  
    486546||= isFollow =||= 是否关注老师，1：是，0：否 =||=tag =||= 标签，最多三个 =|| 
    487547||= isSupport =||= 是否点赞，1：是，0：否 =||=courseList =||= 相关课程，两条 =|| 
    488 ||= watchIng =||= 正在看的用户ID，最多6条，直播需要返回=||=rewardTotal =||= 打赏人数 =|| 
     548||= followUserIdList =||= 报名用户的ID，最多8条=||=rewardTotal =||= 打赏人数 =|| 
    489549||= followTotal =||= 关注人数=||=supportTotal =||= 点赞人数 =|| 
    490550||= userName =||= 下单时用过的称呼=||=phoneNum =||= 下单时用过的手机 =|| 
    … …  
    539599            "imageUrl": "http://img.pconline.com.cn/7.jpg", 
    540600            "createTime": "MM-dd hh:mm", 
    541             "supportTotal": 10, 
    542             "replyList": [ 
    543                 { 
    544                     "replyId": 11, 
    545                     "message": "回复内容", 
    546                     "createTime": "MM-dd hh:mm", 
    547                     "nickName": "昵称", 
    548                     "userId": 111 
    549                 } 
    550             ] 
     601            "supportTotal": 10 
    551602        } 
    552603    ] 
    … …  
    560611 
    561612 
    562 === 3.4发表/回复问题 === 
     613=== 3.4发表问题 === 
    563614开发环境：http://dev15.pclady.com.cn/app/sendRequest.jsp  [[BR]] 
    564615线上环境：http://modern.pclady.com.cn/app/sendRequest.jsp [[BR]] 
    … …  
    589640||= courseId =||=课程ID =||= string =||= "" =||= 是 =||=  =|| 
    590641||= message =||=内容=||= string =||= "" =||= 是 =||=回复内容  =|| 
    591 ||= requestID =||=回复ID=||= string =||= "" =||= 否 =||=回复时才需要传  =|| 
    592642||= imageURL =||=图片地址，多个时用英文逗号隔开，最多三张=||= string =||= "" =||= 否 =||=回复时不需要传 =|| 
    593643 
    … …  
    722772||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    723773||courseId||ID|| String ||""||是|| 
    724 ||requestId||如果是问答，需要传此参数|| String ||""||是|| 
    725774 
    726775**返回** 
    … …  
    814863 
    815864 
    816 === 3.9评论发送（评论系统) === 
    817 经评论系统[[BR]] 
    818 url：http://cmt.pcauto.com.cn/action/comment/create_utf8.jsp 
    819  
    820 **说明** 
    821  
    822 > 评论列表页中发表评论 
    823  
    824 **缓存时间** 
    825  
    826 >0分钟 
    827  
    828 **提交方式** 
    829  
    830 > POST 
    831  
    832 **是否登录** 
    833  
    834 > 是 
    835  
    836 **数据来源** 
    837  
    838 > 
    839  
    840 **参数** 
    841  
    842 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =|| 
    843 ||= id =||=话题id =||= string =||= "" =||= 是 =||=  =|| 
    844 ||= url =||=话题url =||= string =||= "" =||= 是 =||=  =|| 
    845 ||= username =||=用户名 =||= string =||= "" =||= 是 =||=  =|| 
    846 ||= anonymous =||=是否匿名 =||= string =||= "" =||= 否 =||= anonymous：匿名,1为匿名（可选参数） =|| 
    847 ||= content =||=回复内容=||= string =||= "" =||= 是 =||=回复内容  =|| 
    848 ||= common_session_id =||=太平洋通行证session =||= string =||= "" =||= 是 =||= cookies中添加 =|| 
    849  
    850  
    851 **返回** 
    852  
    853 {{{#!java 
    854 { 
    855     "commentId":25705754, 
    856     "floor":27, 
    857     "showName":"iostester", 
    858     "brief":"Really good car hm~~~", 
    859     "status":0, 
    860     "createTime":"2013-07-19 10:37:03", 
    861     "resultCode":0, 
    862     "resultMsg":"您的评论已经成功发表。注：评论在审核后才能出现在列表中,谢谢！", 
    863     "userId":25520497 
    864 } 
    865  
    866 }}} 
    867 **返回参数说明** 
    868 ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    869  
    870  
    871  
    872 === 3.10文章评论列表(wap) === 
    873 后端接口地址：http://cmt.pclady.com.cn/action/comment/list_new_json.jsp?url=http://pclady.com.cn/pcladynews/article/197.html&pageNo=1&pageSize=5&reverse=0 [[BR]] 
    874  
    875 mrobot地址：http://mrobot.pclady.com.cn/s/modern/cms/comments.xsp?url=http://pclady.com.cn/pcladynews/article/197.html&pageNo=1&pageSize=5&reverse=0  [[BR]] 
    876  
    877 **说明** 
    878  
    879 > 获取文章评论列表 [[BR]] 
    880  
    881 **缓存时间** 
    882  
    883 >无 
    884  
    885 **提交方式** 
    886  
    887 > GET 
    888  
    889 **是否登录** 
    890  
    891 > 否 
    892  
    893 **数据来源** 
    894  
    895 >编辑后台 
    896  
    897 **参数** 
    898  
    899 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| 
    900 ||=url=||= 文章url =||= string =||= "" =||= 是 =||= 文章url =|| 
    901 ||=pageNo=||= 第几页 =||= int =||= 1 =||= 是 =||= 第几页 =|| 
    902 ||=pageSize=||= 每页显示的条数 =||= int=||= 20 =||= 是 =||= 每页显示的条数 =|| 
    903 ||=reverse =||= 排序方式 =||= int=||= 0 =||= 是 =||= 0  倒序； 1 正序 =|| 
    904  
    905 **返回** 
    906  
    907  
    908 === 3.11根据标签获取公开课列表 ===  
     865=== 3.9根据标签获取公开课列表 ===  
    909866开发环境：http://dev15.pclady.com.cn/app/courseListWithTag.jsp  [[BR]] 
    910867线上环境：http://modern.pclady.com.cn/app/courseListWithTag.jsp [[BR]] 
    … …  
    986943 
    987944 
    988 === 3.12打赏===  
     945=== 3.10打赏===  
    989946 
    990947开发环境：http://dev15.pclady.com.cn/app/createReward.jsp  [[BR]] 
    … …  
    1033990 
    1034991 
    1035 === 3.13支付结果提交===  
     992=== 3.11支付结果提交===  
    1036993 
    1037994开发环境：http://dev15.pclady.com.cn/app/submitPayResult.jsp  [[BR]] 
    … …  
    10801037 
    10811038 
    1082 === 3.14报名===  
     1039=== 3.12报名===  
    10831040 
    10841041开发环境：http://dev15.pclady.com.cn/app/createOrder.jsp  [[BR]] 
    … …  
    11321089 
    11331090 
    1134 === 3.15获取打赏信息 ===  
     1091=== 3.13获取打赏信息 ===  
    11351092开发环境：http://dev15.pclady.com.cn/app/rewardInfo.jsp  [[BR]] 
    11361093线上环境：http://modern.pclady.com.cn/app/rewardInfo.jsp [[BR]] 
    … …  
    11881145 
    11891146 
    1190 === 3.16取消用户订单 === 
     1147=== 3.14取消用户订单 === 
    11911148 
    11921149开发环境：http://dev15.pclady.com.cn/app/cancelOrder.jsp  [[BR]] 
    … …  
    12321189 
    12331190 
    1234 === 3.17商品(wap) ===  
     1191=== 3.15商品(wap) ===  
    12351192开发环境：http://dev15.pclady.com.cn/app/commodityList.jsp  [[BR]] 
    12361193线上环境：http://modern.pclady.com.cn/app/commodityList.jsp [[BR]] 
    … …  
    12971254 
    12981255 
    1299 === 3.18发现列表 ===  
     1256=== 3.16发现列表 ===  
    13001257开发环境：http://dev15.pclady.com.cn/app/findList.jsp  [[BR]] 
    13011258线上环境：http://modern.pclady.com.cn/app/findList.jsp [[BR]] 
    … …  
    13601317[[BR]] 
    13611318 
    1362 === 3.19视频课终端页(wap) ===  
     1319=== 3.17视频课终端页(wap) ===  
    13631320开发环境：http://dev15.pclady.com.cn/app/videoCourseInfo.jsp  [[BR]] 
    13641321线上环境：http://modern.pclady.com.cn/app/videoCourseInfo.jsp [[BR]] 
    … …  
    14521409||= isFollow =||= 是否关注老师，1：是，0：否 =||=tag =||= 标签，最多三个 =|| 
    14531410||= isSupport =||= 是否点赞，1：是，0：否 =||=courseList =||= 相关课程，两条 =|| 
    1454 ||= watchIng =||= 正在看的用户ID，最多6条，直播需要返回=||=rewardTotal =||= 打赏人数 =|| 
    1455 ||= followTotal =||= 关注人数=||=supportTotal =||= 点赞人数 =|| 
    1456 ||= userName =||= 下单时用过的称呼=||=phoneNum =||= 下单时用过的手机 =|| 
    1457 [[BR]] 
    1458  
    1459  
    1460 === 3. 20保存观看过的视频教程 ===  
    1461 开发环境：http://dev15.pclady.com.cn/app/saveWatchVideo.jsp  [[BR]] 
    1462 线上环境：http://modern.pclady.com.cn/app/saveWatchVideo.jsp [[BR]] 
    1463 mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/saveWatchVideo.jsp 
    1464  
    1465 **说明** 
    1466  
    1467 >保存观看过的视频教程[[BR]] 
    1468  
    1469 **缓存时间** 
    1470  
    1471 >0分钟 
    1472  
    1473 **是否登录** 
    1474  
    1475 > 是 
    1476  
    1477 **提交方式** 
    1478  
    1479 >POST 
    1480  
    1481 **数据来源** 
    1482  
    1483 > 后台 
    1484  
    1485 **参数** 
    1486  
    1487 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    1488 ||= courseId =||= 课程ID =||= String =||= "" =||= 是 =|| 
    1489  
    1490 **返回** 
    1491  
    1492 {{{#!java 
    1493 { 
    1494     "status": 0, 
    1495     "msg": "请求成功", 
    1496     "data":"返回测试结果的节点" 
    1497 } 
    1498  
    1499 }}} 
    1500  
    1501 **返回参数说明** 
    1502 [[BR]] 
     1411[[BR]] 
     1412 
    15031413 
    15041414---------- 
    … …  
    15361446||pageNo||页数||int||1||是|| 
    15371447||pageSize||页面大小||int||10||是|| 
    1538 ||techType||老师类型，1：老师，2：达人||int||0||否|| 
     1448||techType||老师类型，0为全部||int||0||否|| 
     1449||isTop||为1时，表示查询置顶的，首页查询人气老师时用到||int||0||否|| 
    15391450 
    15401451**返回** 
    … …  
    15471458    "pageSize": 20, 
    15481459    "total": 100, 
     1460    "type"[ 
     1461        { 
     1462                "techType":1, 
     1463                "title":"老师" 
     1464        } 
     1465    ] 
    15491466    "data": [ 
    15501467        { 
    … …  
    15731490开发环境：http://dev15.pclady.com.cn/app/techInfo.jsp  [[BR]] 
    15741491线上环境：http://modern.pclady.com.cn/app/techInfo.jsp [[BR]] 
    1575 mrobot地址：http://mrobot.pclady.com.cn/x/app/liveCourseInfo.jsp 
     1492mrobot地址：http://mrobot.pclady.com.cn/x/app/techInfo.jsp 
    15761493 
    15771494**说明** 
    … …  
    16831600**是否登录** 
    16841601 
    1685 > 否，如果未登录，返回freeCourse节点，如果是登录的，要返回freeCourse和用户信息 
     1602> 是 
    16861603 
    16871604**数据来源** 
    … …  
    17151632        "city":"城市", 
    17161633        "job":"职位", 
    1717         "freeCourse": { 
    1718             "courseId": 11, 
    1719             "price": 1, 
    1720             "imageUrl": "http://img.pconline.com.cn/7.jpg", 
    1721             "title": "课程标题" 
    1722         }, 
    17231634        "classes": { 
    17241635            "courseId": 11, 
    … …  
    18191730 
    18201731||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    1821 ||= type =||= 1:直播课,2:视频课 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     1732||= type =||= 1:直播课,2:视频课 最多返回最近的20条=||= 类型 =||= 默认值 =||= 是否必须 =|| 
    18221733||pageNo||页数||int||1||是|| 
    18231734||pageSize||页面大小||int||10||是|| 
    … …  
    21152026 
    21162027 
    2117 === 5. 8测试(wap) ===  
    2118 开发环境：http://dev15.pclady.com.cn/app/testing.jsp  [[BR]] 
    2119 线上环境：http://modern.pclady.com.cn/app/testing.jsp [[BR]] 
    2120 mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/testing.jsp 
    2121  
    2122 **说明** 
    2123  
    2124 >测试[[BR]] 
     2028=== 5.8注册引导(wap) ===  
     2029开发环境：http://dev15.pclady.com.cn/app/testResultList.jsp  [[BR]] 
     2030线上环境：http://modern.pclady.com.cn/app/testResultList.jsp [[BR]] 
     2031mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/testResultList.jsp 
     2032 
     2033**说明** 
     2034 
     2035>获取测试结果[[BR]] 
    21252036 
    21262037**缓存时间** 
    … …  
    21342045**提交方式** 
    21352046 
    2136 >POST 
     2047>GET 
    21372048 
    21382049**数据来源** 
    … …  
    21462057||= 待定 =||=  =||= String =||= "" =||= 是 =|| 
    21472058||= 待定 =||=  =||= String =||= "" =||= 是 =|| 
    2148  
    2149 **返回** 
    2150  
    2151 {{{#!java 
    2152 { 
    2153     "status": 0, 
    2154     "msg": "请求成功", 
    2155     "data":"返回测试结果的节点" 
    2156 } 
    2157  
    2158 }}} 
    2159  
    2160 **返回参数说明** 
    2161 [[BR]] 
    2162  
    2163  
    2164 === 5.9测试结果(wap) ===  
    2165 开发环境：http://dev15.pclady.com.cn/app/testResultList.jsp  [[BR]] 
    2166 线上环境：http://modern.pclady.com.cn/app/testResultList.jsp [[BR]] 
    2167 mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/testResultList.jsp 
    2168  
    2169 **说明** 
    2170  
    2171 >获取测试结果[[BR]] 
    2172  
    2173 **缓存时间** 
    2174  
    2175 >0分钟 
    2176  
    2177 **是否登录** 
    2178  
    2179 > 是 
    2180  
    2181 **提交方式** 
    2182  
    2183 >GET 
    2184  
    2185 **数据来源** 
    2186  
    2187 > 后台 
    2188  
    2189 **参数** 
    2190  
    2191 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    21922059 
    21932060**返回**