Changes between Initial Version and Version 1 of pcauto_club_4.2.0/api

Timestamp:

05/13/2015 09:20:05 AM (11 years ago)

Author:

liangzhicong

Comment:

--

pcauto_club_4.2.0/api

@@ +1 @@
+[[PageOutline(1-100,接口索引)]]
+
+== 1. 车友会提供APP接口4.2(车友圈） ==
+=== 1.1 车友会相关接口
+
+==== 1.1.1 绑定车友圈 ====
+{{{
+接口/appapi/1.0/forum/bundUserForum.do [POST]
+说明 : 绑定车友圈
+请求参数 ：
+  forumId:版块ID
+  forumName:版块名字
+
+
+是否登录 : 是
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+==== 1.1.2 解绑车友圈 ====
+{{{
+接口/appapi/1.0/forum/unBundUserForum.do [POST]
+说明 : 解绑车友圈
+请求参数 ：
+  forumId:版块ID
+
+
+是否登录 : 是
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+==== 1.1.3 获取用户绑定车友圈列表 ====
+{{{
+接口/appapi/1.0/forum/listForumsByUserId.do [GET]
+说明 : 获取用户绑定车友圈列表
+请求参数 ：
+
+
+
+是否登录 : 是
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   userId:用户ID
+   forumList:[
+      {
+         forumId:版块ID
+         forumName:版块名字
+      }
+   ]
+
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+
+==== 1.1.4 判断用户是否绑定某车友圈 ====
+{{{
+接口/appapi/1.0/forum/isBound.do [GET]
+说明 : 判断用户是否绑定某车友圈
+请求参数 ：
+
+   userId:用户ID
+   forumId:版块ID
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   userId:用户ID
+   forumId:版块ID
+   isBound：是否绑定（0：未绑定；1：已绑定）
+
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+==== 1.1.5 获取主题对应的动态ID ====
+{{{
+接口/appapi/1.0/forum/getDynaByTopicId.do [GET]
+说明 : 获取主题对应的动态ID
+请求参数 ：
+
+   topicId:主题ID
+   createDate:主题创建时间（yyyy-MM-dd hh:mm:ss)
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   topicId:主题ID
+   createDate:主题创建日期
+   dynaInfoId:动态ID
+
+
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+==== 1.1.7 获取同城动态列表 ====
+{{{
+说明：获取同城动态列表
+接口：/appapi/3.0/dyna/getTongChengDynaList.do [GET]
+请求参数：
+      *provinceId 发动态省地区id（必选）
+      cityId 发动态市地区id（无则不传）
+
+是否登录:否
+缓存时间:无
+是否分页:是
+
+
+返回
+{
+
+        dynaList:[
+            {
+                dynaInfoId：动态id，
+                postCount:回复数
+                pubTime: 发布时间, 
+                createBy: 创建者ID, 
+                nickName:作者昵称,
+                isHasImg: 是否有图片(0:没有，1：有）, 
+                petrol: 贡献油值, 
+                authorPhoto: 作者头像, 
+                isVip：是否认证，（0：否，1：是）
+                praiseCount：点赞数
+
+                dynaType:动态类型(1-普通帖子（旧数据包含提问帖子），2-说说动态，3-图片动态，4-提问帖子，5-公告动态，6-活动动态，7-新会员加入动态，8-创建车友会动态）
+                                
+                //以上是动态列表公共字段
+                //下面是根据不同的动态类型，返回不同的字段或内容
+                dynaType == 1，4
+                         dynaTargetId:帖子ID
+                         content:帖子内容 
+                         topicTitle: 帖子标题,
+                         isPick: 是否是精华（0：不是，1：是，2：是）, 
+                         isRecommend: 是否是推荐（0：不是，1：是）,
+                         forumId: 板块ID, 
+                         forumName: 板块名称, 
+                         forumUrl:板块URL
+                         
+
+                                   
+                dynaType == 2
+                         dynaTargetId ：说说动态ID
+                         content:说说内容
+                         clubName:车友会名字
+                         clubUrl:车友会URL
+                                   
+                                           
+                                   
+                images:[
+                     {
+                        url:http://xxxx.jpg,
+                        //真实宽度
+                        width:960,
+                        //真实高度
+                        height:1000
+                      },
+                     {
+                        url:http://xxxx.jpg,
+                        //真实宽度
+                        width:960,
+                        //真实高度
+                        height:1000
+                      }
+                ]
+           }
+     ]
+
+        total:总条数
+        pageNo:页码
+        pageSize:每页条数
+        pageCount:总共几页
+
+        code:0成功，-1失败
+        message:提示信息
+        version: 接口版本号如1.0，1.0（latest)表示最新版本
+        
+}
+}}}
+=== 1.2  论坛相关接口
+
+==== 1.2.1 车友圈信息 ====
+{{{
+接口/appapi/1.0/forum/bundUserForum.do [GET]
+说明 : 车友圈信息
+请求参数 ：
+          fids:"板块id多个时以','分开"
+
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+    {
+    "forumList": [
+        {
+            "forumDesc": "",
+            "forumIcon": "http://img.pconline.com.cn/images/upload/upc/tx/auto5/1304/02/c5/19467254_1364888380062_270x202.jpg",
+            "forumId": 14674,
+            "forumName": "嘉年华论坛",
+            "forumUrl": "http://localhost.pcauto.com.cn/bbs7/forum-14674.html",
+            "todayNewPostCount": 1530,
+            "topicCount": 14143
+        }
+    ],
+
+    "code": 0成功，-1失败,
+    "message": 提示信息,
+    "version": 接口版本号如1.0，1.0（latest)表示最新版本
+    }
+}}}
+==== 1.2.2 车友圈主题列表 ====
+{{{
+接口/appapi/1.0/forum/bundUserForum.do [GET]
+说明 : 车友圈主题列表 
+请求参数 ：
+
+
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+
+==== 1.2.3 车友圈置顶主题列表 ====
+{{{
+接口/appapi/1/forum/getForumTop.do [GET]
+说明 : 车友圈置顶主题列表 
+请求参数 ：
+         forumId:
+   
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+
+    "topList": [
+        {
+            "containImage": false,
+            "createAt": "2015-05-06 11:08:14",
+            "isPick": false,
+            "nickname": "深海无声",
+            "replyCount": 4,
+            "title": "提问贴子买车",
+            "topicId": 7808466,
+            "topicUrl": "http://localhost.pcauto.com.cn/bbs7/topic-7808466.html",
+            "updateAt": "2015-05-08 14:04:50",
+            "userId": 826717,
+            "username": "fit10",
+            "viewCount": 1
+        }
+    ],
+      "code": 0成功，-1失败,
+    "message": 提示信息,
+    "version": 接口版本号如1.0，1.0（latest)表示最新版本
+
+
+}}}
+==== 1.2.4 主题终端 ====
+{{{
+接口/appapi/1.0/forum/bundUserForum.do [GET]
+说明 : 主题终端 
+请求参数 ：
+
+
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+
+==== 1.2.5 主题跟帖列表 ====
+{{{
+接口/appapi/1.0/forum/bundUserForum.do [GET]
+说明 : 主题跟帖列表
+请求参数 ：
+
+
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+
+==== 1.2.6 主题图片表 ====
+{{{
+接口/appapi/1/forum/getImagesByTid.do [GET]
+说明 : 主题图片表
+请求参数 ：
+        topicId:
+        size: 所需的图片张数
+
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+    "imgList": [
+        {
+            "exLink": 0,
+            "height": 529,
+            "seq": 1,
+            "url": "http://img.pconline.com.cn/images/upload/upc/tx/bbs6/1406/13/c5/35235990_1402638068263_1024x1024.png",
+            "width": 684
+        },
+   ],
+   imgSize: 12,
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+
+=== 1.3  修改个人资料相关接口
+
+==== 1.3.1 修改个人资料 ====
+{{{
+接口/appapi/1.0/user/updateUserInfo.do [POST]
+说明 : 修改个人资料
+请求参数 ：
+
+  nickName：昵称
+  gender：姓别 (0:男,1:女）
+  birthday：出生日期(yyyy-MM-dd)
+  cityId: 城市ID
+  cityName: 城市名字
+  provinceId: 省ID
+  provinceName: 省份名字
+  brandId: 品牌ID
+  brandName：品牌名字
+  serialId: 车系ID
+  serialName: 车系名字
+
+是否登录 : 是
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+{
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+
+==== 1.3.2 获取个人资料 ====
+{{{
+接口/appapi/1.0/user/getUserInfo.do [GET]
+说明 : 修改个人资料
+请求参数 ：
+
+  userId: 用户ID
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+
+{
+   nickName：昵称
+   gender：姓别 (0:男,1:女）
+   birthday：出生日期(yyyy-MM-dd)
+   provinceId: 省ID
+   provinceName: 省名字
+   cityId: 城市ID
+   cityName: 城市名字
+   brandId: 品牌ID
+   brandName：品牌名字
+   serialId: 车系ID
+   serialName: 车系名字
+
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+==== 1.3.3 判断个人资料是否完整 ====
+{{{
+接口/appapi/1.0/user/isCompleteUserInfo.do [GET]
+说明 : 判断个人资料是否完整
+请求参数 ：
+
+  userId: 用户ID
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+
+{
+   userId: 用户ID
+   isComplete: 资料是否完整（0：不完整；1：完整）
+
+   code : 0成功，-1失败
+   message : 提示信息
+   version : 接口版本号如1.0，1.0（latest)表示最新版本
+}
+}}}
+
+== 2. mrobot 合并 ==
+
+==== 2.1.0 主题终端 ====
+{{{
+主题终端(1.2.5)需要将 动态ID列表(1.1.5) 和 点赞状态列表(1.1.10)合并
+
+接口  [GET]
+说明 : 主题终端(1.2.5)需要将 动态ID列表(1.1.5) 和 点赞状态列表(1.1.10)合并
+请求参数 ：
+
+  userId: 用户ID
+
+是否登录 : 否
+缓存时间 : 无
+是否分页 : 否
+
+
+返回结果：
+
+{
+   
+}
+}}}
+
+
+
+
+{{{
+#!html
+<div style="background-color: #dfdede; border-radius: 5px 0 0 5px; height: 35px; overflow: hidden; width: 30px; z-index: 9999; float: right; padding: 3px 0px 0px 2px; right: 0; top: 300px;position: fixed;">
+  <a href="#a1.车友会提供的接口汇总"><em>返回<br>顶部</em></a>
+</div>
+}}}