Changes between Version 1 and Version 2 of yimei2.2.0_api

Timestamp:

09/28/2015 09:34:13 AM (11 years ago)

Author:

caomenglin

Comment:

--

yimei2.2.0_api

@@ -12 +12 @@
 == 1.首页 ==
 ----------
+
 === 1.1精选机构 （修改）=== 
 开发环境：http://dev15.pclady.com.cn/app/indexOrgList.jsp  [[BR]]
@@ -82 +83 @@
 ||= plScore =||= 星级 =||=serviceScore =||= 服务=||
 ||= technologyScore =||= 技术 =||=environmentScore =||= 环境=||
-||= city =||= 有机构的城市，过滤查询时用到 =||=activityTotal =||= 活动数=||
-
-
+||= city =||= pageNo==1&&非过滤查询时才返回该节点，有机构的城市，过滤查询时用到 =||=activityTotal =||= 活动数=||
+
+== 2.帖子 ==
+=== 2.1帖子详情页(修改) ===
+'''(mrobot已完成，请连开发机进行测试)'''[[BR]]
+开发环境：http://dev15.pclady.com.cn/app/postInfo.jsp  [[BR]]
+          http://dev15.pclady.com.cn/app/commentList.jsp [[BR]]
+线上环境：http://plastic.pclady.com.cn/app/postInfo.jsp [[BR]]
+          http://plastic.pclady.com.cn/app/commentList.jsp [[BR]]
+mrobot地址：  http://mrobot.pclady.com.cn/s/yimei/circle/topic.xsp
+
+**说明**
+
+> 帖子终端页，应用端只需要出数据，wap页由mrobot来完成。
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 查询收藏状态时需要登录，其它情况不需要登录
+
+**数据来源**
+
+>整形库编辑后台
+
+**修改内容**
+
+>1：返回时添加活动、日记、帖子、医院、医生、项目,点击头像等节点（project、userHead、doctor、hospital、post、diary、activity） [[BR]]
+2：请求参数添加appVersion参数
+
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||
+||pageNo||页数||int||1||是||=  =||
+||pageSize||页面大小||int||10||是||=  =||
+||= postID =||=帖子ID =||= string =||= "" =||= 是 =||=  =||
+||= deviceID =||=设备ID =||= string =||= "" =||= 是 =||=  =||
+||fmt||fmt=json 时显示接口json数据||String||""||是||=  =||
+||isExample||isExample==1时表示旧案例数据||int||""||= 否 =||  =||
+||hiddenReply||hiddenReply==1时表示客户端请求html，只需要返回帖子内容,并在html中返回json数据||int||""||= 否 =||  =||
+||appVersion||版本号||String||"app版本号为x.x.x是，参数 传xxx，去掉小数点"||否|| =||
+
+**返回**
+
+{{{#!java
+
+{
+    "status": 0,
+    "msg": "请求成功",
+    "pageNo": 1,
+    "pageSize": 20,
+    "total": 100,
+    "title": "",
+    "nickName": "",
+    "userID": "",
+    "userAge": 1,
+    "userCity": "",
+    "circleName": "",
+    "commentCount": 1,
+    "laudCount": 2,
+    "hasCollect": "",
+    "isessence": 1,
+    "ispublicationPhoto": 1,
+    "hasLaud": 1,
+    "sysTime": "系统当前时间YYYY-MM-DD HH:mm:ss",
+    "data": [
+        {
+            "postDependId": 122,
+            "content": "",
+            "imageList": [
+                "image1",
+                "image2",
+                "image3"
+            ],
+            "largeImageList": [
+                "image1",
+                "image2",
+                "image3"
+            ],
+            "createTime": "",
+            "activity": [
+                {
+                    "activitiesID": "",
+                    "title": "",
+                    "imageUr": "",
+                    "price": "999",
+                    "discountPrice": 1
+                }
+            ],
+            "diary": [
+                {
+                    "contentID": "内容ID",
+                    "imageUrl": "",
+                    "title": "",
+                    "commentCount": 1,
+                    "laudCount": 1,
+                    "dateTime": "刚刚"
+                }
+            ],
+            "post": [
+                {
+                    "contentID": "内容ID",
+                    "imageUrl": "",
+                    "title": "",
+                    "commentCount": 1,
+                    "laudCount": 1,
+                    "dateTime": "刚刚"
+                }
+            ],
+            "hospital": [
+                {
+                    "hospitalID": 1,
+                    "name": "医院名称",
+                    "imageUrl": "",
+                    "activityTotal": 1,
+                    "exampleTotal": 1,
+                    "doctorTotal": 1
+                }
+            ],
+            "doctor": [
+                {
+                    "name": "陈柯",
+                    "doctorID": "",
+                    "imageUrl": "",
+                    "job": ""
+                }
+            ],
+            "project": [
+                {
+                    "projectID": 201,
+                    "name": "项目名称"
+                }
+            ]
+        }
+    ],
+    "projectList": [
+        {
+            "projectID": 11,
+            "projectName": ""
+        },
+        {
+            "projectID": 11,
+            "projectName": ""
+        }
+    ],
+    "org": {
+        "hospital": "",
+        "doctor": "",
+        "hospitalCity": "",
+        "price": 1200
+    },"userHead":[
+      "1234","1234"
+   ]
+}
+
+html中的json
+{
+  "circleName":""
+  "commentCount":1,
+  "laudCount":2,
+  "hasCollect":""
+  "hasLaud":1,
+  "userID":"",
+  "title":"",
+  "data":[{
+      "largeImageList":["image1","image2","image3"]
+"
+}],
+}
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= title =||=标题=||= data =||=帖子数据=||
+||= nickName =||=发布人昵称=||= userID =||=为自己时，界面下文显示续写帖子=||
+||= age =||=发布人年龄=||= city =||=发布人所在城市=||
+||= circleName =||=圈子名=||= content =||=帖子内容=||
+||= hasCollect =||=1：收藏，2：未收藏 =||= createTime =||=发帖时间=||
+||= commentCount=||=评论数 =||=laudCount=||=点赞数=||
+||= imageList=||=列表显示小尺寸图片      =||=largeImageList=||=查看时需要请求大尺寸图片=||
+||= isessence=||=是否精华：1：是，0：否   =||=ispublicationPhoto=||=是否晒单：1：是，0：否=||
+||= hasLaud=||=是否点赞，1：已点赞，0：未点赞 =||=projectList,org=||=旧案例数据可能会包括这两个节点的信息，没有该数据时，节点也不返回=||
+||= postDependId=||=帖子节点        =||==||==||
+
+== 3评论 ==
+=== 3.1回复评论（修改） ===
+开发环境：http://dev15.pclady.com.cn/app/replyComment.jsp  [[BR]]
+线上环境：http://plastic.pclady.com.cn/app/replyComment.jsp [[BR]]
+
+**说明**
+
+> 回复
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+> POST
+
+**是否登录**
+
+> 是
+
+**数据来源**
+
+>整形库编辑后台
+
+**修改**
+
+>1：请求添加三个参数imageUrl、diaryID，postID[[BR]]
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||
+||= contentID =||=文章ID =||= string =||= "" =||= 是 =||=  =||
+||= contentType =||=文章类型 =||= string =||= "" =||= 是 =||= 1：日记，2：帖子=||
+||= replyID =||=回复ID=||= string =||= "" =||= 否 =||=直接评论日记或帖子时，不需要传  =||
+||= replySecondID =||=回复二级ID=||= string =||= "" =||= 否 =||==直接评论日记或帖子时，不需要传 =||
+||= replyContent =||=回复内容=||= string =||= "" =||= 是 =||=回复内容  =||
+||= imageUrl =||=图片=||= string =||= "" =||= 否 =||=图片地址  =||
+||= diaryID =||=日记ID=||= string =||= "" =||= 否 =||=插入日记 =||
+||= postID =||=帖子ID=||= string =||= "" =||= 否 =||=插入帖子 =||
+
+
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功"
+  "Integral":1
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= Integral=||=奖励积分=||==||==||
+
+
+=== 3.2评论列表（修改） ===
+'''(mrobot已完成，请连开发机进行测试)'''[[BR]]
+开发环境：http://dev15.pclady.com.cn/app/commentList.jsp?contentID=1&contentType=1  [[BR]]
+线上环境：http://plastic.pclady.com.cn/app/commentList.jsp [[BR]]
+mrobot地址：  http://mrobot.pclady.com.cn/s/yimei/circle/commentList.xsp 
+
+**说明**
+
+> 获取评论列表
+
+**缓存时间**
+
+>0分钟
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>整形库编辑后台
+
+
+**修改**
+
+>1：返回时添加imageUrl参数、diary节点，post节点 [[BR]]
+
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||
+||pageNo||页数||int||1||是||||
+||pageSize||页面大小||int||10||是||||
+||= contentID =||=文章ID =||= string =||= "" =||= 是 =||=  =||
+||= contentType =||=文章类型 =||= string =||= "" =||= 是 =||= 1：日记，2：帖子=||
+
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功",
+  "pageNo": 1, 
+  "pageSize": 20,
+  "total":100,
+  "commentCount":1000
+  "sysTime":"系统当前时间YYYY-MM-DD HH:mm:ss",
+  data[
+    "commentID":""
+    "userID":"评论人ID",
+    "nickName":"评论人昵称",
+    "commentTime":"回复时间",
+    "commentContent":"回复内容",
+    "imageUrl":"",
+    "diary":{
+       "contentID":132,
+       "title":"",
+       "imageUrl":"",
+       "time":""
+    },
+    "post":{
+       "contentID":132,
+       "title":"",
+       "imageUrl":"",
+       "time":""
+    },
+    reply:[{
+      "replyID":"回复ID",
+      "nickName":"跟贴人昵称",
+      "userID":"跟贴人ID",
+      "replyTime":"跟贴时间",
+      "replyContent":"跟贴内容"
+      "replyStarter":"是否楼主回复",
+      "starterNickName":"楼主昵称",
+      "starterID":"楼主ID",
+      "replyToUserID":"回复某人ID",
+      "replyToNickName":"回复某人昵称",
+"
+}]
+]
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= commentID =||= 评论ID =||=replyStarter=||=是否回复楼主1：是，2：否=||
+||= userID =||= 用户ID =||=nickName=||=昵称=||
+||= commentTime =||= 评论时间 =||=commentContent=||=评论内容=||
+||= replyTime =||= 回复时间 =||=replyContent=||=回复内容=||
+||= starterID =||= 楼主ID，用于添加楼主标签 =||=replyContent=||=回复内容=||
+||= replyToUserID =||= 回复某人ID，如果是直接回复评论的，返回为空 =||=replyToNickName=||=回复某人昵称，如果是回复评论的，返回为空=||
+||= total =||= 总数，用于分页 =||=commentCount=||=评论总数=||
+
+== 4.晒单 ==
+=== 4.1获取晒单信息 ===
+开发环境：http://dev15.pclady.com.cn/app/getDiaryByOrder.jsp  [[BR]]
+线上环境：http://plastic.pclady.com.cn/app/getDiaryByOrder.jsp [[BR]]
+mrobot地址：  http://mrobot.pclady.com.cn/s/yimei/my/getDiaryByOrder.xsp 
+
+**说明**
+
+> 获取审核未通过的晒单信息
+
+**缓存时间**
+
+>0
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 是
+
+**数据来源**
+
+>整形库编辑后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||pageNo||页数||int||1||是||
+||pageSize||页面大小||int||10||是||
+||orderID||ys||int||10||是||
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功",
+  "diaryDependId":111,
+  "contentID":1,
+  "title":""
+  "diaryContent":"日记内容",
+  "imageList":["image1","image2","image3"]
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= contentID =||= 日记ID=||= diaryDependId =||=日记节点ID=||
+||= title =||= 标题=||= diaryContent =||=日记内容=||
+||= imageList =||= 图片地址，返回原图的地址=||= =||==||
+
+
+=== 4.2用户消息列表（修改） ===
+（mrobot已完成，请连开发机进行测试） [[BR]]
+开发环境：http://dev15.pclady.com.cn/app/myMessageList.jsp  [[BR]]
+线上环境：http://plastic.pclady.com.cn/app/myMessageList.jsp [[BR]]
+mrobot地址：  http://mrobot.pclady.com.cn/s/yimei/my/myMessageList.xsp?pageNo=1&pageSize=10
+
+**说明**
+
+> 获取用户消息列表
+
+**缓存时间**
+
+>0
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 是
+
+**数据来源**
+
+>整形库编辑后台
+
+**修改**
+
+>1：返回参数修改，审核不通过时，urlType返回6 [[BR]]
+2：请求时添加appVersion参数，大于等于2.2.0时要返回晒单不通过的类型 [[BR]]
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||pageNo||页数||int||1||是||
+||pageSize||页面大小||int||10||是||
+||appVersion||版本号||int||10||是||
+
+**返回**
+
+{{{#!java
+{
+  "status":0,
+  "msg":"请求成功",
+  "pageNo": 1, 
+  "pageSize": 20,
+  "total": 100,
+  "sysTime":"系统当前时间YYYY-MM-DD HH:mm:ss
+"
+  "data":[{ 
+    "messageID":"",
+    "messageType":1,
+    "replyAccountName":"", 
+    "replyAccountId":"", 
+    "urlType":””,
+    "title":"" 
+    "imageUrl":"", 
+    "commentContent":"", 
+    "replyContent":"",
+    "createTime":"刚刚",
+    "url":"http"
+    }
+  ]
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= replyAccountName =||= 回复人或评论人的昵称，系统消息可不传，APP写死=||= replyAccountId =||=用户ID或系统ID，用于查看ta的主页,系统ID默认为0=||
+||= urlType =||=回复类型 1：日记，2：帖子，3：活动（系统消息可能包括活动推广）,4：外链，5：删除,0：系统消息，6:审核不通过=||= imageUrl =||=推荐图，系统消息中可发送图片=||
+||= commentContent =||=消息内容=||= createTime =||=消息发送时间=||
+||= messageId =||= 消息ID=||= messageType =||=消息类型，0：系统消息，1：评论，2：回复，3：收藏推送=||
+||= url =||= 内容ID或外链，对应urlType，当urlType=4时为外链=||= replyContent =||=回复标题，分别为：日记标题，帖子标题，回复内容，如果只是系统推送的消息，不需要返回=||
+||= title =||= 系统消息标题=||
+
+== 5.案例 ==
+=== 1.4获取案例列表（修改） ===
+开发环境：http://dev15.pclady.com.cn/app/getExampleList.jsp  [[BR]]
+线上环境：http://plastic.pclady.com.cn/app/getExampleList.jsp [[BR]]
+mrobot环境：http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/getExampleList.jsp
+
+**说明**
+
+>获取案例列表
+
+**缓存时间**
+
+>15分钟
+
+**提交方式**
+
+>GET
+
+**数据来源**
+
+> 整形库编辑后台
+
+**修改内容**
+
+> 1：请求参数添加appVersion，版本号大于等于2.1.0需要返回日记和案例 [[BR]]
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=||
+||pageNo||页数||int||1||是||||
+||pageSize||页面大小||int||3||是||||
+||age||年龄段||int||""||否||||
+||positionID||部位ID||String||""||否||部位，一级分类ID、感兴趣ID||
+||subPositionID||部位ID||String||""||否||功效，二级分类ID||
+||projectID||项目ID||String||""||否||三级分类ID||
+||doctorID||医生ID||String||""||否||医生主页中会根据医生来获取案例||
+||businessID||医院ID||String||""||否||医院主页中会根据医院来获取案例||
+||city||城市||String||""||否||首页查询时用到||
+||activityID||活动ID||String||""||否||活动详情页用到||
+||appVersion||版本号||String||""||否||版本号大于等于2.1.0时，需要返回日记和案例||
+
+
+**返回**
+
+{{{#!java
+{
+    "status": 0,
+    "msg": "请求成功",
+    "pageNo": 1,
+    "pageSize": 20,
+    "total": 100,
+    " data": [
+        {
+            "contentID": "",
+            "type": 1,
+            "title": "",
+            "desc": "",
+            "imageUrl": [
+                "",
+                "",
+                ""
+            ],
+            " username": "小美",
+            "time": "2015-01-24",
+            "userTypeImage":["",""],
+            " essence": 1,
+            "publicationPhoto": 1
+        }
+    ]
+}
+
+}}}
+
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+||= contentID =||=案例ID或日记ID=||= type =||= 类型：1：日记，2：案例=||
+||= title =||=标题=||= desc =||= 描述=||
+||= imageUrl =||=图片=||= username =||= 昵称=||
+||= essence =||=是否精华：1：是，0：否=||= publicationPhoto =||= 是否晒单：1：是，0：否=||
+||= time =||=发布时间=||= userTypeImage=||=达人图杜地址,支持返回多个图片 =||