wiki:pcauto_club_4.0.0/api

Version 46 (modified by liangzhicong, 11 years ago) (diff)

--

1. 投票相关

1.1用户发布投票

1.1.1 用户发布投票
接口/appapi/1.0/vote/createVote.do [POST]

1.2用户投票

1.1.4 用户进行投票
接口/appapi/1.0/vote/takeVote.do [POST]

2.相册相关

2.1创建相册列表

1.2.1 创建/修改相册
接口/appapi/1.0/album/editAlbum.do [POST]

2.2根据id返回相册列表

1.2.2 根据相册ID返回相片列表
接口/appapi/1.0/album/getPhotoByAlbumId.do [GET]

2.3上传图片

1.2.2 上传图片
接口/appapi/1.0/album/uploadPhotos.do [POST]

2.4设置封面

1.2.3 设置封面 
接口/appapi/1.0/album/setAlbumCover.do [POST]

2.5删除照片

1.2.5 删除照片(批量)
接口/appapi/1.0/album/delPhotos.do [POST]

2.6删除相册

1.2.6 删除相册
接口/appapi/1.0/album/delAlbum.do [POST]

2.7 评论照片

1.2.11 评论照片
接口/appapi/1.0/photo/replyPhoto.do [POST]

2.8 获取照片评论

1.2.13 获取照片评论列表
接口/appapi/1.0/photo/getReplyList.do [GET]

2.9 照片点赞/取消赞

1.2.14 照片点赞/取消赞
接口:/appapi/1.0/photo/doPraise.do [POST]

2.10 照片点赞列表

1.2.17 获取照片点赞用户列表
接口:/appapi/1.0/photo/getPraiseUserList.do [GET]

3.活动相关

3.1 发布/更新活动

1.3.1 发布/更新活动 
接口/appapi/1.0/activity/editActivity.do [POST]

3.2 删除活动

1.3.6 删除活动
接口:/appapi/1.0/activity/delActivity[POST]

3.3 活动报名

1.3.7 活动报名
接口:/appapi/1.0/activity/applyActivity[POST]

3.4 活动审核

1.3.8 活动审核
接口:/appapi/1.0/activity/auditApply[POST]

3.5 活动审核列表

1.3.9 活动报名列表(审核中)
接口:/appapi/1.0/activity/getApplyingList[GET]

3.6 活动报名列表

1.3.10 活动报名列表(审核通过)
接口:/appapi/1.0/activity/getApplyedList[GET]

3.7 取消活动报名

1.3.12 取消活动报名
接口:/appapi/1.0/activity/cancelActivity.do[POST]

4.首页相关

4.1 签到列表

1.4.1 今日签到排行列表
接口:/appapi/1.0/club/todayCheckInList.do[GET]

4.2 设置动态置顶

1.4.2 设置动态置顶
接口:/appapi/1.0/dyna/setDynaTop.do[POST]

4.3 取消动态置顶

1.4.3 取消动态置顶
接口:/appapi/1.0/dyna/cancelDynaTop.do[POST]

4.4 删除动态

1.4.9 删除动态
接口:/appapi/1.0/dyna/deleteDyna.do[POST]

mrobot合并

基本约定:
可以连开发机代理或者域名改成相对应环境域名

开发机代理:192.168.10.199 端口为 1080(开发机)
开发机域名:http://dev40.pcauto.com.cn

测试机代理:
测试机域名:

1.1投票详情

1.1.2 获取投票详情
接口:/xsp/s/club/v4.0/vote_detail.xsp?userId=30257562&voteId=301

请求参数:
||参数名||类型||必须||说明||
||voteId||String||Y||投票ID||
||userId||String||Y||用户ID||

返回结果:
{
	code: 0,
	message: "操作成功",
	version: "v1.0(latest)",
	voteCount: 0,
	voteId: 301,
	voteItems: [
		{
			voteItem: "读书",
			voteItemCount: 0,
			voteItemId: 251
		},
		{
			voteItem: "认字",
			voteItemCount: 0,
			voteItemId: 252
		},
		{
			voteItem: "看电视",
			voteItemCount: 0,
			voteItemId: 253
		}
	],
	voteTitle: "好好学习的方法是?",
	hasVoteItemId: 0 //此id为返回用户已投项id votedItemId,无则为0
}

源接口/appapi/1.0/vote/getVoteDetail.do [GET]
1.1.3 判断用户是否已投票 
源接口/appapi/1.0/vote/hasVoted.do [GET]
增加返回用户已投项id votedItemId

1.2 活动列表

1.3.3 活动列表
接口:/xsp/s/club/v4.0/activity_list.xsp?clubId=5381&clubUrl=dynaclub&userId=30257562

请求参数:
||参数名||类型||必须||说明||
||clubId||String||Y||车友会ID||
||clubUrl||String||Y||车友会域名||
||userId||String||N||用户Id||
返回结果:
{
	clubId: 5381,
	clubName: "凤凰车友会",
	clubUrl: "dynaclub",
	code: 0,
	data: [
		{
			activityCost: 123,
			activityId: 4071,
			activityPlace: "北京市",
			activityType: 1,
			beginDate: 1428243060000,
			createBy: 30257562,
			dayCount: 5,
			endDate: 1428588660000,
			limitCount: 0,
			nickName: "test_xl",
			pic: "http://dev2.pconline.com.cn:9191/upcfiles/autoclub/1502/06/c0/6992_1423188755365_1024x1024.jpg",
			signupDate: 1428329460000,
			title: "wqerqwerqwer",
			isSignUp: 3,
			statusMsg: "报名结束",
			statusCode: 101,
			applyCount: 1 //只是通过审核的人数,没有则为0
		},
		{},
		{},
	],
	message: "操作成功",
	pageCount: 2,
	pageNo: 1,
	pageSize: 20,
	total: 24,
	version: "v2.0(latest)"
}

源接口:/appapi/2.0/activity/getActivityList.do [GET]
增加返回
//isSignUp:是否报名
//statusMsg:状态名字,服务器返回显示火热报名,已报名等状态的文字,app建议直接读取这个新的字段显示
//statusCode:状态码
源接口:
1.3.4 获取活动状态提示 
接口:/appapi/1.0/activity/getActivityStatus.do [GET]
1.3.5 判断用户是否已报名
接口:/appapi/1.0/activity/hasApplyed [GET]

1.3 活动详情

1.3.2 活动详情
接口:/xsp/s/club/v4.0/activity_detail.xsp?activityId=4041

请求参数:
||参数名||类型||必须||说明||
||activityId||String||Y||活动ID||

返回结果:
{
	activityId: 4041,
	activityImgUrl: "http://baidu.com",
	activityPlace: "北京市",
	activityType: 1,
	authorTel: "15089699344",
	beginDate: 1423065611000,
	clubId: 5381,
	code: 0,
	content: "222222222",
	contentImages: [ ],
	createAt: 1423124305000,
	createBy: 30257562,
	destinationPlaces: [ ],
	endDate: 1423929611000,
	gatherPlace: {
		latitude: 39.91516771771552,
		longitude: 116.4038742349945,
		name: "abc"
	},
	limitCount: 0,
	message: "操作成功",
	money: 0,
	nickName: "test_xl",
	signupDate: 1423497611000,
	title: "111111",
	userName: "test_xl",
	version: "v1.0(latest)",
	statusMsg: "报名结束",
	statusCode: 101,
        applys:[
             {
                userId: 30257562 //用户id
             }
        ]//从getApplyedList拿,小于等于6个
        applyCount: 1 //只是通过审核的人数,没有则为0
        dynaInfoId://动态id,如果无则返回0;
        isSignup://是否报名(0:审核中, 1:报名成功,2:未报名)
}

源接口:
1.3.2 活动详情
/appapi/1.0/activity/getActivityDetail.do [GET]
增加返回
//statusMsg:状态名字,服务器返回显示火热报名,已报名等状态的文字,app建议直接读取这个新的字段显示
//statusCode:状态码
源接口
1.3.4 获取活动状态提示 
接口:/appapi/1.0/activity/getActivityStatus.do [GET]
来源
1.3.5 判断用户是否已报名
接口:/appapi/1.0/activity/hasApplyed [GET]
1.3.11 判断活动是否生成过动态(旧数据没有评论功能)
接口:/appapi/1.0/activity/hasDynaByActivityId.do[GET]

1.4 活动成员列表

1.4 活动成员列表
接口:/xsp/s/club/v4.0/activity_member_list.xsp?pageNo=1&pageSize=20&activityId=4071

请求参数:
||参数名||类型||必须||说明||
||activityId||String||Y||活动ID||
||pageNo||String||Y||页数||
||pageSize||String||Y||每页显示条数||

返回结果:
{
      	applying: [ ],  //没有结果就返回空数组,第一页时返回申请审核列表,当page>1时不需要再次请求        
	applyed: [ 
		{
			descript: "22222222222222222222",
			joinNum : 11,
			lincensePlate: "222222222",
			memberId: 26721,
			nickName : "test_xl",
			phone: "15920908586",
			userId: 30257562,
			userName : "vvvvvvvv"
		}
	] //没有结果就返回空数组
}

来源
1.3.9 活动报名列表(审核中)
接口:/appapi/1.0/activity/getApplyingList[GET]
1.3.10 活动报名列表(审核通过)
接口:/appapi/1.0/activity/getApplyedList[GET]

1.5 相册首页列表

1.5 相册首页列表
接口:http://mrobot.pcauto.com.cn/xsp/s/club/v4.0/album_homepage_list.xsp?pageNo=1&pageSize=20&clubId=5381

请求参数:
||参数名||类型||必须||说明||
||clubId||String||Y||车友会ID||
||pageNo||String||Y||页数||
||pageSize||String||Y||每页显示条数||
结果
{

   clubId : 车友会ID
   clubName : 车友会名字
   pageNo:页码
   pageSize:每页条数
   pageCount:总共几页
   total:总条数

   
   albumList : [
          {
            albumId : 相册ID
            albumName : 相册名字
            coverUrlSmall : 封面图片
            createAt : 相册创建时间
            createBy : 相册创建者
            nickName : 创建者昵称
            authorPhoto : 创建者头像
            isVip : 是否认证
            photoSize : 相片数
            photoList : [
                {
                  photoId : 照片ID
                  urlSamll : 小图片
                  urlBig : 大图片
                 },
                 {
                  photoId : 照片ID
                  urlSamll : 小图片
                  urlBig : 大图片
                 }   
            ]            
           },],
   lastList:[
        {
          albumId : 相册ID
          photoId : 照片ID
          urlSamll : 小图片
          urlBig : 大图片
          createAt : 照片创建时间
        },
   ]//1.3.0 获取车友会最新照片列表 前4张
}
来源
1.2.1 根据车友会ID,返回相册列表
接口/appapi/1.0/album/getAlbumByClubId.do [GET]
1.3.0 获取车友会最新照片列表
接口/appapi/1.0/album/getLatestPhotosByClubId.do [GET]

1.6车友会首页

接口:http://mrobot.pcauto.com.cn/xsp/s/club/v4.0/homepage.xsp?pageNo=1&pageSize=20&clubId=5381&userId=30257562


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

请求参数:
||参数名||类型||必须||说明||
||clubId||String||Y||车友会ID||
||userId||String||Y||用户ID||
||pageNo||String||Y||页数||
||pageSize||String||Y||每页显示条数||

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

        total:总条数
        pageNo:页码
        pageSize:每页条数
        pageCount:总共几页

        applyCount:新用户申请加入数   //1.1.37功能

       dynaTopList : [      //1.4.4 功能
        {
         dynaInfoId : 动态ID
         dynaType : 动态类型
         content: 动态内容(图片用【图】代替)
         dynaTargetId : 动态目标ID
        }]

         checkInList : [  //1.4.1功能
         {
          userId : 签到者ID
          nickName : 签到者昵称
          checkInTime : 签到时间(时间戳)
         }] 

	dynaList:[
	    {
	        dynaInfoId:动态id,
		postCount:回复数
		pubTime: 发布时间, 
		forumId: 板块ID, 
		forumName: 板块名称, 
		createBy: 创建者ID, 
		nickName:作者昵称,
		isHasImg: 是否有图片(0:没有,1:有), 
		petrol: 贡献油值, 
		authorPhoto: 作者头像, 
		isVip:是否认证,(0:否,1:是)
		praiseCount:点赞数
                hadPraise:已赞(根据当前登录的用户是否赞过此动态) //1.1.31功能

		dynaType:动态类型(1-普通帖子(旧数据包含提问帖子),2-说说动态,3-图片动态,4-提问帖子,5-公告动态,6-活动动态,7-新会员加入动态,8-创建车友会动态)
				
		//以上是动态列表公共字段
		//下面是根据不同的动态类型,返回不同的字段或内容
		dynaType == 1,4
		         dynaTargetId:帖子ID
		         content:帖子内容 
		         topicTitle: 帖子标题,
		         isPick: 是否是精华(0:不是,1:是,2:是), 
		         isRecommend: 是否是推荐(0:不是,1:是)
				   
		dynaType == 2
			 dynaTargetId :说说动态ID
			 content:说说内容
				   
		dynaType == 3
			 dynaTargetId :相册ID
		         content:上传了100张相片到《相册名字》
				   
		dynaType == 5
                         content : 发布了公告:XXXXXXXXXXXX
				   
		dynaType == 6
			 dynaTargetId :活动ID
			 content:发起了活动:活动标题
                         signUpCount:成功报名人数
                         activityCost:每人花费	
                         activityCover : 活动封面图
                 
                dynaType == 7
                         content : Hello,我已经加入了 + 车友会名字 + ,现在我是一个有组织的人了,欢迎大家来围观	
                 
                dynaType == 8 
                         content : 创建了+ clubName + 车友会主页: + targetUrl + , 大家快去邀请车友加入吧	

                dynaType == 9	
                        dynaTargetId: 动态ID
                        content : 投票标题
                        voteCount: 投票人数				   
				   
		images:[
		     {
			url:http://xxxx.jpg,
			//真实宽度
			width:960,
			//真实高度
			height:1000
		      },
                     {
			url:http://xxxx.jpg,
			//真实宽度
			width:960,
			//真实高度
			height:1000
		      }
	        ]
	   }
     ]
}

应用端接口:
说明:获取动态列表(返回动态图片列表)
接口:/appapi/2.0/dyna/getDynaListImages.do [GET]
请求参数
	*clubId:车友会id

来源:
1.1.31 判断是否已赞 [返回:动态是否已赞]
接口:/appapi/1.0/dyna/getHadPraiseList.do [GET]

1.1.37 车友会成员列表接口  [返回:会长登陆,返回申请人数]
接口:/appapi/1.0/member/getMemberList.do [GET]

1.4.4 获取动态置顶列表 [返回:置顶列表]
接口:/appapi/1.0/dyna/dynaTopList.do[GET]

1.4.1 今日签到排行列表 [返回:签到用户的信用]
接口:/appapi/1.0/club/todayCheckInList.do[GET]

1.7 照片详情(赞、评论)

1.2.12 获取照片评论数和赞数
接口:http://mrobot.pcauto.com.cn/xsp/s/club/v4.0/photos_praise_detail.xsp?photoId=54661&albumId=6651 GET

是否登录:是

请求参数:
||参数名||类型||必须||说明||
||photoId||String||Y||照片ID||
||albumId||String||Y||相册ID||

{
	albumId: 6651,
	code: 0,
	message: "操作成功",
	photoId: 54661,
	praiseCount: 1,
	replyCount: 0,
	version: "v1.0(latest)",
	hadPraisePhotoIds: "54661" //有则返回photoID,无则为空
}

应用端接口
1.2.12 获取照片评论数和赞数:
/appapi/1.0/photo/getReplyPraiseCount.do [GET]

增加返回当前用户是否已赞 hadPraise字段,来源如下:
1.2.18 判断是否已赞过照片:
/appapi/1.0/photo/getHadPraiseList.do [GET]

1.8 车友会论坛列表

1.4.6 帖子列表(发布时间倒序)
接口:/appapi/1.0/topic/topicListByCreateTime.do[GET]

1.4.7 帖子列表(回复时间倒序)
接口:/appapi/1.0/topic/topicListByPostTime.do[GET]

增加帖子已读数
来源
1.4.8 获取帖子被查看次数(由论坛提供)
接口:${BBSROOT}/clubapi/1/getTopicView.do[GET]

其他

PV统计

1.5.1 添加车友会pv
接口:/appapi/1.0/club/addVisitorPv.do [POST]