wiki:appapi/4.2

Version 32 (modified by guhenghong, 11 years ago) (diff)

--

1. 车友会提供APP接口4.2(车友圈)

备注:

1.1,1.3相关,开发环境URL前缀: http://dev18.pcauto.com.cn/

1.2相关,开发环境URL前缀: http://dev11.pcauto.com.cn:12085/bbs7/

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/forum/findForums.do [GET]
说明 : 车友圈信息
请求参数 :
          fids:"板块id多个时以','分开"


是否登录 : 否
缓存时间 : 无
是否分页 : 否


返回结果:
    {
    "forumList": [
        {
            "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",
            "latestTopicContent": "正文[表情]下一个呢[表情]后面就是上传的图片了\n\n\n\n",
            "todayNewPostCount": 1535
        }
    ],

    "code": 0成功,-1失败,
    "message": 提示信息,
    "version": 接口版本号如1.0,1.0(latest)表示最新版本
    }

1.2.2 车友圈基本信息

接口/appapi/1/forum/findForums.do [GET]
说明 : 车友圈信息
请求参数 :
          fids:"板块id多个时以','分开"


是否登录 : 否
缓存时间 : 无
是否分页 : 否


返回结果:
    {
    "forumList": [
        {
            "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",
            "topicCount": 14145
        }
    ],

    "code": 0成功,-1失败,
    "message": 提示信息,
    "version": 接口版本号如1.0,1.0(latest)表示最新版本
    }

1.2.3 车友圈主题列表

接口/appapi/1/forum/listTopicsByForumId.do [GET]
说明 : 车友圈主题列表 
请求参数 :
         forumId:板块id
         filter: 选择精华贴时“pick” 其他可以不传
         orderby: 选择最新贴时"postat"发布时间排序, 其它可以不传
         pageNo:  页码
         pageSize:  页码大小

是否登录 : 否
缓存时间 : 无
是否分页 : 是


返回结果:
{
"forum": {
        "bbs": 19,
        "forumId": 14674,
        "name": "嘉年华论坛",
        "parentId": 298
    },
    "message": "操作成功",
    "pageNo": 1,
    "pageSize": 50,
    "topicList": [
           {
            "author": {
                "isVip": true,
                "name": "xhchen",
                "nickname": "ok呀",
                "userId": 63145,
                "userface": "http://i6.3conline.com/images/upload/upc/face/63/14/5/63145_100x100",
                "validBrandIcon": "http://img0.pcauto.com.cn/pcauto/1112/07/1743776_ACS5050.png"
            },
            "content": "正文[表情]下一个呢[表情]后面就是上传的图片了\n\n\n\n",
            "createAt": 1431941116000,
            "images": [
                {
                    "height": 720,
                    "seq": 1,
                    "url": "http://test745.pcauto.com.cn:9191/bbs6/1502/16/c0/3474270_1424050883042_1024x1024.jpg",
                    "width": 482
                }
            ],
            "imagesSize": 1,
            "isPick": false,
            "lastpostAt": 1431941116000,
            "replyCount": 0,
            "title": "普通贴",
            "topicId": 7808734,
            "uri": "http://localhost.pcauto.com.cn/bbs7/topic-7808734.html"
        },
   ]
   "total": 18048,
   code : 0成功,-1失败
   message : 提示信息
   version : 接口版本号如1.0,1.0(latest)表示最新版本
}

1.2.4 车友圈置顶主题列表

接口/appapi/1/forum/getForumTop.do [GET]
说明 : 车友圈置顶主题列表 
请求参数 :
         forumId:
   

是否登录 : 否
缓存时间 : 无
是否分页 : 否


返回结果:

    "topList": [
        {
            "containImage": false,
            "isPick": false,
            "title": "提问贴子买车",
            "topicId": 7808466,
            "topicUrl": "http://localhost.pcauto.com.cn/bbs7/topic-7808466.html",
            "updateAt": "2015-05-08 14:04:50"
        }
    ],
      "code": 0成功,-1失败,
    "message": 提示信息,
    "version": 接口版本号如1.0,1.0(latest)表示最新版本


1.2.5 主题终端

接口/appapi/1/forum/topic.do [GET]
说明 : 主题终端 
请求参数 :
         topicId:
         pageNo:
         pageSize:直接读取默认配置不需要传


是否登录 : 否
缓存时间 : 无
是否分页 : 否


返回结果:
{
    "curAllImage": [],
    "pageCount": 1,
    "pageNo": 1,
    "pageSize": 19,
    "postList": [
        {
            "agent": 0,
            "author": {
                "validBrandIcon": "http://img2.pcauto.com.cn/pcauto/1011/29/1328175_nissan.png"(用户认证的品牌图标) 
                "isVip": false,
                "level": "太平洋舰队元帅",
                "model": "天籁 2.0L XE 标准版",
                "name": "fit10",
                "nickname": "深海无声",
                "userId": 826717
            },
            "createAt": 1430881694000,
            "floor": 1,
            "forGrade": -1,
            "gradeAmount": 0,
            "gradeCount": 0,
            "message": "fdasfadsfdasfadsfadsfdasfasdffdasf",
            "postId": 56638606,
            "status": 0
        },
   ]
   "topic": {
        "author": {
            "level": "太平洋舰队元帅",
            "name": "fit10",
            "nickname": "深海无声",
            "userId": 826717
        },
        "bbsId": 19,
        "createAt": 1430881694000,
        "forumId": 14674,
        "forumName": "嘉年华论坛",
        "isContainImage": false,
        "isLock": false,
        "isPick": false 是否为精华贴,
        "isRecommend": false,
        "lastPostAt": 1431065090000,
        "replyCount": 4,
        "title": "提问贴子买车",
        "uri": "http://localhost.pcauto.com.cn/bbs7/topic-7808466.html",
        "view": 1
    },
    "total": 5
   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.2.7 发帖接口

接口/appapi/1/forum/createTopic.do [GET]
说明 : 主题图片表
请求参数 :
        forumId:
        topicType: (""/"question")发帖的种类(普通贴)/提问)
        appTitle:标题
        type: 帖子类型例如:“讨论、新车作业、用车心得..”
        message:正文
        messageImage:图片+图片描述
        qType:问题类别
        qSubtype:问题子类别

是否登录 : 否
缓存时间 : 无
是否分页 : 否


返回结果:
{
   "Location":"http://localhost.pcauto.com.cn/bbs7/topic-7808773.html", 
   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)表示最新版本
}
返回
顶部