Changes between Version 3 and Version 4 of pclady_modern1.0.0_api

Timestamp:

02/24/2016 05:55:06 PM (10 years ago)

Author:

caomenglin

Comment:

--

pclady_modern1.0.0_api

@@ -56 +56 @@
 **返回参数说明**
 ||= 参数名 =||= 参数含义 =||
-||= status =||= 0:成功，-1：已存在，-2：用户被禁用 ,-3：其它原因=||
+||= status =||= 0:成功，-1：用户被禁用，-2：其它失败原因=||
 
 
@@ -345 +345 @@
 
 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
-||pageNo||页数||int||1||是||
-||pageSize||页面大小||int||10||是||
+||courseId||课程ID||String||""||是||
 
 **返回**
@@ -375 +374 @@
         "techDesc": "老师描述",
         "isFollow": 1,
-        "isGood": 1,
+        "isSupport": 1,
+        "followTotal":100,
+        "supportTotal":100,
+        "rewardTotal":100,
+        "phoneNum":"13333333333",
+        "userName":"下单时用过的称呼",
         "tag": [
             {
@@ -413 +417 @@
 ||= techIconUrl =||= 老师等级icon =||=techType =||= 老师类型，1：老师，2：达人 =||
 ||= isFollow =||= 是否关注老师，1：是，0：否 =||=tag =||= 标签，最多三个 =||
-||= isGood =||= 是否点赞，1：是，0：否 =||=courseList =||= 相关课程，两条 =||
-||= watchIng =||= 正在看的用户ID，最多6条，直播需要返回=||= =||=  =||
+||= isSupport =||= 是否点赞，1：是，0：否 =||=courseList =||= 相关课程，两条 =||
+||= watchIng =||= 正在看的用户ID，最多6条，直播需要返回=||=rewardTotal =||= 打赏人数 =||
+||= followTotal =||= 关注人数=||=supportTotal =||= 点赞人数 =||
+||= userName =||= 下单时用过的称呼=||=phoneNum =||= 下单时用过的手机 =||
 [[BR]]
 
@@ -446 +452 @@
 
 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||courseId||课程ID||String||""||是||
 ||pageNo||页数||int||1||是||
 ||pageSize||页面大小||int||10||是||
@@ -482 +489 @@
 **返回参数说明**
 ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
-||=  =||= =||= =||=  =||
 [[BR]]
+
+
+=== 3.4发表/回复问题 ===
+开发环境：http://dev15.pclady.com.cn/app/sendRequest.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/sendRequest.jsp [[BR]]
+
+**说明**
+
+> 发表问题
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+> POST
+
+**是否登录**
+
+> 是
+
+**数据来源**
+
+>整形库编辑后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||
+||= courseId =||=课程ID =||= string =||= "" =||= 是 =||=  =||
+||= message =||=内容=||= string =||= "" =||= 是 =||=回复内容  =||
+||= requestID =||=回复ID=||= string =||= "" =||= 否 =||=回复时才需要传  =||
+||= imageURL =||=图片地址，多个时用英文逗号隔开，最多三张=||= string =||= "" =||= 否 =||=回复时不需要传 =||
+
+
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功"
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+
+=== 3.5收藏/取消收藏  === 
+开发环境：http://dev15.pclady.com.cn/app/collection.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/collection.jsp [[BR]]
+mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/collection.jsp
+
+**说明**
+
+> 收藏/取消收藏
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+> POST
+
+**是否登录**
+
+> 是
+
+**数据来源**
+
+>
+
+**参数**
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||courseId||ID，批量取消收藏时，用英文逗号隔开|| String ||""||是||
+||type||类型：1：视频，2：一对一|| int ||""||是||
+||operation||操作：1：收藏，2：取消收藏|| int ||""||是||
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功"
+  "state":1
+}
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= state =||= 1:收藏，0：未收藏，返回状态是为了防止网络不太稳定的时候，连续点击，客户端状态更新错误，批量操作不需要返回 =||==||==||
+
+=== 3.6关注/取消关注老师  === 
+开发环境：http://dev15.pclady.com.cn/app/followTech.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/followTech.jsp [[BR]]
+mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/followTech.jsp
+
+**说明**
+
+> 关注/取消关注老师
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+> POST
+
+**是否登录**
+
+> 是
+
+**数据来源**
+
+>
+
+**参数**
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||techId||ID，批量取消关注时，用英文逗号隔开|| String ||""||是||
+||operation||操作：1：关注，2：取消关注|| int ||""||是||
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功"
+  "state":1
+}
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= state =||= 1:关注，0：未关注，返回状态是为了防止网络不太稳定的时候，连续点击，客户端状态更新错误 =||==||==||
+
+
+=== 3.7点赞  === 
+开发环境：http://dev15.pclady.com.cn/app/support.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/support.jsp [[BR]]
+mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/support.jsp
+
+**说明**
+
+> 点赞
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+> POST
+
+**是否登录**
+
+> 直播课报名之后才可以点赞；普通视频不需要登录也可以点赞。问答点赞也需要登录
+
+**数据来源**
+
+>
+
+**参数**
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||courseId||ID|| String ||""||是||
+||requestId||如果是问答，需要传此参数|| String ||""||是||
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功",
+  "supportTotal":100
+}
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= supportTotal =||= 点赞成功后要返回点赞总数 =||=参数名=||=参数含意=||
+
+
+=== 3.8课后答疑 === 
+开发环境：http://dev15.pclady.com.cn/app/answerList.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/answerList.jsp [[BR]]
+mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/answerList.jsp
+
+**说明**
+
+>课后答疑列表[[BR]]
+
+**缓存时间**
+
+>0分钟
+
+**是否登录**
+
+> 否
+
+**提交方式**
+
+>GET
+
+**数据来源**
+
+> 后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||courseId||课程ID||String||""||是||
+||pageNo||页数||int||1||是||
+||pageSize||页面大小||int||10||是||
+
+**返回**
+
+{{{#!java
+{
+    "status": 0,
+    "msg": "请求成功",
+    "info": {
+        "courseId": 11,
+        "liveType": 1,
+        "title": "课程标题",
+        "imageUrl": "封面图",
+        "startTime": "YYYY-MM-dd hh:mm",
+        "shareUrl": "http://wap.pclady.com.cn/111.html",
+        "techId": 1111,
+        "techJobName": "××御用化妆师",
+        "techNickName": "老师姓名",
+        "techIconUrl": "http://img.pconline.com.cn/7.jpg",
+        "courseDesc": "课程描述"
+    },
+    "data": [
+        {
+            "answerId": 11,
+            "type": 1,
+            "message": "答疑内容",
+            "customerHead": "小助手头像",
+            "userHead": "用户头像",
+            "imageUrl": "图片",
+            "voiceUrl": "语音地址",
+            "voiceState": 1,
+            "voiceLength": 10,
+            "publicNumber": "公众号"
+        }
+    ]
+}
+
+}}}
+
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= type =||= 1:问答小助手,2:用户 =||= voiceState =||= 1：已读，0：未读 =||
+||= voiceLength =||= 语音长度 =||= publicNumber =||= 公众号 =||
+[[BR]]
+
+
+=== 3.9评论发送（评论系统) ===
+经评论系统[[BR]]
+url：http://cmt.pcauto.com.cn/action/comment/create_utf8.jsp
+
+**说明**
+
+> 评论列表页中发表评论
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+> POST
+
+**是否登录**
+
+> 是
+
+**数据来源**
+
+>
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||
+||= id =||=话题id =||= string =||= "" =||= 是 =||=  =||
+||= url =||=话题url =||= string =||= "" =||= 是 =||=  =||
+||= username =||=用户名 =||= string =||= "" =||= 是 =||=  =||
+||= anonymous =||=是否匿名 =||= string =||= "" =||= 否 =||= anonymous：匿名,1为匿名（可选参数） =||
+||= content =||=回复内容=||= string =||= "" =||= 是 =||=回复内容  =||
+||= common_session_id =||=太平洋通行证session =||= string =||= "" =||= 是 =||= cookies中添加 =||
+
+
+**返回**
+
+{{{#!java
+{
+    "commentId":25705754,
+    "floor":27,
+    "showName":"iostester",
+    "brief":"Really good car hm~~~",
+    "status":0,
+    "createTime":"2013-07-19 10:37:03",
+    "resultCode":0,
+    "resultMsg":"您的评论已经成功发表。注：评论在审核后才能出现在列表中,谢谢！",
+    "userId":25520497
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+
+
+
+=== 3.10文章评论列表 （WEB）===
+后端接口地址：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]]
+
+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]]
+
+**说明**
+
+> 获取文章评论列表 [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>编辑后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=||
+||=url=||= 文章url =||= string =||= "" =||= 是 =||= 文章url =||
+||=pageNo=||= 第几页 =||= int =||= 1 =||= 是 =||= 第几页 =||
+||=pageSize=||= 每页显示的条数 =||= int=||= 20 =||= 是 =||= 每页显示的条数 =||
+||=reverse =||= 排序方式 =||= int=||= 0 =||= 是 =||= 0  倒序； 1 正序 =||
+
+**返回**
+
+
+=== 3.11根据标签获取公开课列表 === 
+开发环境：http://dev15.pclady.com.cn/app/courseListWithTag.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/courseListWithTag.jsp [[BR]]
+mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/courseListWithTag.jsp
+
+**说明**
+
+>获取公开课列表,默认加载10条[[BR]]
+>显示顺序：正在直播和预告优先显示。其余按回顾直播课的开始时间、视频教程的启用时间，新到旧排列[[BR]]
+> 由于需要查询正在直播的视频，先不考虑缓存[[BR]]
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+>GET
+
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+> 后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||pageNo||页数||int||1||是||
+||pageSize||页面大小||int||10||是||
+||tagId||标签Id||int||10||是||
+
+**返回**
+
+{{{#!java
+{
+    "status": 0,
+    "msg": "请求成功",
+    "pageNo": 1,
+    "pageSize": 20,
+    "total": 100,
+    "data": [
+        {
+            "courseId": 11,
+            "liveType": 1,
+            "liveTime": "6'33''",
+            "startTime": "MM.dd hh:mm",
+            "imageUrl": "http://img.pconline.com.cn/7.jpg",
+            "techId": 1111,
+            "techJobName": "××御用化妆师",
+            "techNickName": "老师姓名",
+            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
+            "techType": 1,
+            "title": "课程标题",
+            "watchTotal": 100,
+            "tag": [
+            {
+                "tagId": 11,
+                "tagName": "标签"
+            }
+        ]
+        }
+    ]
+}
+
+}}}
+
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= liveType =||= 1:直播,2:预告,3:视频教程 =||= liveTime =||= 视频时长 =||
+||= imageUrl =||= 封面图 =||=watchTotal =||= 如果是直播，返回观看人数 =||
+||= techID =||= 老师ID =||=techJobName =||= 头衔 =||
+||= startTime =||= 如果为预告，要返回开始时间 =||=tag =||= 标签，最多三个 =||
+||= techIconUrl =||= 老师等级icon =||=techType =||= 老师类型，1：老师，2：达人 =||
+[[BR]]
+
+
+=== 3.12打赏=== 
+
+开发环境：http://dev15.pclady.com.cn/app/createReward.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/createReward.jsp [[BR]]
+
+**说明**
+
+>创建打赏订单 
+
+**缓存时间**
+
+>0
+
+**提交方式**
+
+>POST
+
+**是否需要登录**
+
+>是
+
+**数据来源**
+
+> 整形库编辑后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||courseId||课程id||String||""||是||
+||amount||打赏金额|| int ||""||是||
+||content||打赏理由||String||""||是||
+||r||时间截||String||""||是||
+||sign||MD5加密串||String||""||是||
+
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功",
+  "orderID":"12424234234",
+  "orderNO":"流水号ID"
+}
+}}}
+
+
+=== 3.13支付结果提交=== 
+
+开发环境：http://dev15.pclady.com.cn/app/submitPayResult.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/submitPayResult.jsp [[BR]]
+
+**说明**
+
+>支付完后，客户端发送日志给服务端 
+
+**缓存时间**
+
+>0
+
+**提交方式**
+
+>POST
+
+**是否需要登录**
+
+>是
+
+**数据来源**
+
+> 整形库编辑后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+|| orderNO ||流水号ID||String||""||是||
+|| payTime ||支付时间：yyyyMMddhhmmss||String||""||是||
+|| payStatus||支付状态,支付返回的状态0:成功，-1:失败,-2：取消||String||""||是||
+|| payType||支付类型 1=支付宝，2=微信||String||""||是||
+|| payMessage ||支付信息，支付结果信息，如支付成功，取消支付，支付失败||String||""||是||
+||r||时间截||String||""||是||
+||sign||MD5加密串||String||""||是||
+
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功",
+}
+}}}
+
+
+=== 3.14报名=== 
+
+开发环境：http://dev15.pclady.com.cn/app/createOrder.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/createOrder.jsp [[BR]]
+
+**说明**
+
+>报名，用于创建订单 
+
+**缓存时间**
+
+>0
+
+**提交方式**
+
+>POST
+
+**是否需要登录**
+
+>是
+
+**数据来源**
+
+> 整形库编辑后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||courseId||课程id||String||""||是||
+||userName||称呼|| int ||""||是||
+||phoneNum||手机号码||String||""||是||
+||remind||是否短信提醒，1：提醒，0：不提醒||String||""||是||
+||r||时间截||String||""||是||
+||sign||MD5加密串||String||""||是||
+
+
+**返回**
+
+{{{#!java
+{
+    "status": 0,
+    "msg": "请求成功",
+    "orderID ": 1111,
+    "orderNO": "流水号ID"
+}
+}}}
+
+
+=== 3.15创建微信订单=== 
+
+开发环境：http://dev15.pclady.com.cn/app/createWechatOrder.jsp  [[BR]]
+线上环境：http://plastic.pclady.com.cn/app/createWechatOrder.jsp [[BR]]
+
+**说明**
+
+>生成微信订单 
+
+**缓存时间**
+
+>0
+
+**提交方式**
+
+>POST
+
+**是否需要登录**
+
+>是
+
+**数据来源**
+
+> 整形库编辑后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+|| orderNO ||流水号ID||String||""||是||
+||r||时间截||String||""||是||
+||sign||MD5加密串||String||""||是||
+
+
+**返回**
+
+{{{#!java
+{
+    "status": 0,
+    "msg": "请求成功",
+    "timestamp": "时间戳",
+    "appid": "应用ID",
+    "partnerid": "商户ID",
+    "prepayid": "预支付订单",
+    "noncestr": "随机串",
+    "package": "商家根据财付通文档填写的数据和签名",
+    "sign": "签名"
+}
+}}}
+
+== 4.一对一 ==
+=== 4.1获取一对一教程列表 === 
+开发环境：http://dev15.pclady.com.cn/app/chatCourseList.jsp  [[BR]]
+线上环境：http://modern.pclady.com.cn/app/chatCourseList.jsp [[BR]]
+mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/chatCourseList.jsp
+
+**说明**
+
+>获取一对一教程列表,默认加载10条[[BR]]
+> 由于考虑到价钱有变，先不考虑缓存[[BR]]
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+>GET
+
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+> 后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||pageNo||页数||int||1||是||
+||pageSize||页面大小||int||10||是||
+
+**返回**
+
+{{{#!java
+{
+    "status": 0,
+    "msg": "请求成功",
+    "pageNo": 1,
+    "pageSize": 20,
+    "total": 100,
+    "data": [
+        {
+            "courseId": 11,
+            "imageUrl": "http://img.pconline.com.cn/7.jpg",
+            "price": 1111,
+            "gradeImageUrl": "http://img.pconline.com.cn/7.jpg",
+            "title": "课程标题",
+            "desc":"描述",
+            "buyTotal"，100
+        ]
+        }
+    ]
+}
+
+}}}
+
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= liveType =||= 课程难度icon =||= liveTime =||= 视频时长 =||
+||= imageUrl =||= 封面图 =||=watchTotal =||= 如果是直播，返回观看人数 =||
+||= techID =||= 老师ID =||=techJobName =||= 头衔 =||
+||= startTime =||= 如果为预告，要返回开始时间 =||=tag =||= 标签，最多三个 =||
+||= techIconUrl =||= 老师等级icon =||=techType =||= 老师类型，1：老师，2：达人 =||
+[[BR]]