1. 车友会提供APP接口4.0
1.1 投票相关
1.1.1 用户发布投票
接口/appapi/1.0/vote/createVote.do [POST]
说明 : 用户发布投票
请求参数 :
*voteTitle :投票标题
*voteItems : 投票选项,使用“,”连接起来
权限:车友会会员
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.1.2 获取投票详情
接口/appapi/1.0/vote/getVoteDetail.do [GET]
说明 : 获取投票内容
请求参数:
*voteId :投票ID
是否登录 : 否
缓存时间 : 无
是否分页 : 否
返回结果:
{
voteId : 投票ID
voteTitle : 投票标题
voteCount : 投票人数
createBy : 发布者ID
clubId : 车友会ID
voteItems : [
{
voteItemId : 选项ID
voteItem : 选项内容
voteItemCount : 选项被选投次数
},
{
voteItemId : 选项ID
voteItem : 选项内容
voteItemCount : 选项被选投次数
},
{
voteItemId : 选项ID
voteItem : 选项内容
voteItemCount : 选项被选投次数
}
]
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.1.3 判断用户是否已投票
接口/appapi/1.0/vote/hasVoted.do [GET]
说明 : 用户对动态进行投票
请求参数:
*userId : 用户ID
*voteId :投票ID
是否登录 : 否
缓存时间 : 无
是否分页 : 否
返回结果:
{
userId : 用户ID
voteId : 投票ID
hasVoted : 0,未投票;1,已投票
voteItemId : 0,未投票; >0,已投选项
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.1.4 用户进行投票
接口/appapi/1.0/vote/takeVote.do [POST]
说明 : 用户进行投票
请求参数:
*voteId :投票ID
*voteItemId : 投票选项ID
权限:车友会会员
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.1.5 删除投票
接口/appapi/1.0/vote/deleteVote.do [POST]
说明 : 用户删除投票
请求参数:
*voteId :投票ID
权限:发布者,会长,副会长
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2 照片相关
1.2.1 创建/修改相册
接口/appapi/1.0/album/editAlbum.do [POST]
说明 : 创建/修改相册
请求参数:
albumId:相册ID
*albumName : 相册名字
备注:根据登录信息获取车友会信息
albumId > 0时,为修改相册,否则为创建相册
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
albumId : 相册Id
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.2 上传图片
接口/appapi/1.0/album/uploadPhotos.do [POST]
说明 : 上传图片
上传相片指令:
command:53003--700x
command:53004--160x120
command:53016--120x80
command:53017--1024x1024
command:53018--240x160
command:53019--500x500
command:53020--400x400
command:53030--330x220
command:53031--160x107
command:53036--294x294
command:53037--144x144
请求参数:
*albumId:相册ID
*photoList : [
{
name : 图片名字
url : 图片URL
width : 图片宽
height :图片高
},
{
name : 图片名字
url : 图片URL
width : 图片宽
height :图片高
}
]
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.3 设置封面
接口/appapi/1.0/album/setAlbumCover.do [POST]
说明 : 设置封面
请求参数:
*albumId: 相册ID
*photoId: 照片ID
备注:根据登录信息获取车友会信息
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.4 移动照片(批量)
接口/appapi/1.0/album/movePhotos.do [POST]
说明 : 移动照片(批量)
请求参数:
*albumIdMoveIn : 接收照片相册ID
*albumIdMoveOut : 被移出照片的相册ID
*photoIds: 被移动的照片ID,使用“,”连接在一起
备注:根据登录信息获取车友会信息
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.5 删除照片(批量)
接口/appapi/1.0/album/delPhotos.do [POST]
说明 : 删除照片(批量)
请求参数:
*albumId: 相册ID
*photoIds : 用“,”把相册ID连接起来
备注:根据登录信息获取车友会信息
如果找不到相关的照片,当作删除成功
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.6 删除相册
接口/appapi/1.0/album/delAlbum.do [POST]
说明 : 删除相册
请求参数:
*albumId: 相册ID
备注:根据登录信息获取车友会信息
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.7 根据相册ID获取相片列表
接口/appapi/1.0/album/getPhotoByAlbumId.do [GET]
说明 : 根据相册ID获取相片列表
请求参数:
*albumId:相册ID
是否登录 : 否
缓存时间 : 无
是否分页 : 是
返回结果:
{
albumId : 相册ID
albumName : 相册名字
createAt : 相册创建时间
createBy : 相册创建者
nickName : 创建者昵称
authorPhoto : 创建者头像
isVip : 是否认证
isDefault:是否为默认相册(0:是,1:不是)
clubId:车友会ID
photoList : [
{
photoId : 照片ID
createBy : 上传者ID
urlSmall : 小图片(144x144)
urlBig : 大图片 (700)
},
{
photoId : 照片ID
createBy : 上传者ID
urlSmall : 小图片(144x144)
urlBig : 大图片 (700)
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.8 根据用户ID获取相册列表(废用)
接口/appapi/1.0/album/getAlbumByUserId.do [GET]
说明 : 根据用户ID获取相册列表
请求参数:
备注:根据登录信息获取车友会信息
是否登录 : 是
缓存时间 : 无
是否分页 : 是
返回结果:
{
userId : 用户ID
clubId : 车友会ID
albumList : [
{
albumId : 相册ID
albumName : 相册名称
coverUrl : 封面图片URL
isDefault : 0,默认相册;1:不是默认相册
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.9 根据车友会ID获取相册列表
接口/appapi/1.0/album/getAlbumByClubId.do [GET]
说明 : 根据车友会ID获取相册列表
请求参数:
*clubId :车友会ID
是否登录 : 否
缓存时间 : 无
是否分页 : 是
返回结果:
{
clubId : 车友会ID
clubName : 车友会名字
albumList : [
{
albumId : 相册ID
albumName : 相册名字
coverUrlSmall : 封面图片(294x294)
createAt : 相册创建时间
createBy : 相册创建者
nickName : 创建者昵称
authorPhoto : 创建者头像
isVip : 是否认证
photoSize : 相片数
photoList : [
{
photoId : 照片ID
urlSmall : 小图片(144x144)
urlBig : 大图片(700)
},
{
photoId : 照片ID
urlSmall : 小图片(144x144)
urlBig : 大图片(700)
}
]
},
{
albumId : 相册ID
albumName : 相册名字
coverUrlSmall : 封面图片(294x294)
createAt : 相册创建时间
createBy : 相册创建者
nickName : 创建者昵称
authorPhoto : 创建者头像
isVip : 是否认证
photoSize : 相片数
photoList : [
{
photoId : 照片ID
urlSmall : 小图片(144x144)
urlBig : 大图片(700)
},
{
photoId : 照片ID
urlSmall : 小图片(144x144)
urlBig : 大图片(700)
}
]
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.10 获取车友会最新照片列表
接口/appapi/1.0/album/getLatestPhotosByClubId.do [GET]
说明 : 获取车友会最新照片列表 =
请求参数:
*clubId :车友会ID
是否登录 : 否
缓存时间 : 无
是否分页 : 是
返回结果:
{
clubId : 车友会ID
photoList : [
{
albumId : 相册ID
photoId : 照片ID
urlSmall : 小图片(144x144)
urlBig : 大图片(700)
createAt : 照片创建时间
createBy: 图片发布者ID
},
{
albumID : 相册ID
photoId : 照片ID
urlSmall : 小图片(144x144)
urlBig : 大图片(700)
createAt : 照片创建时间
createBy: 图片发布者ID
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.11 评论照片
接口/appapi/1.0/photo/replyPhoto.do [POST]
说明 : 评论照片
请求参数:
*photoId:照片ID
*albumId:相册ID
*content:评论内容
postToPhotoReplyId:被评论的评论ID(如果为空,代表直接评论照片)
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.12 获取照片评论数和赞数
接口/appapi/1.0/photo/getReplyPraiseCount.do [GET]
说明 : 获取照片评论数
请求参数:
*photoId:照片ID
*albumId:相册ID
是否登录 : 否
缓存时间 : 无
是否分页 : 否
返回结果:
{
photoId:照片ID
albumId:相册ID
replyCount:评论数
praiseCount:点赞数
clubId:车友会ID
photoCreateBy:照片创建者ID
albumCreateBy:相册创建者ID
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.13 获取照片评论列表
接口/appapi/1.0/photo/getReplyList.do [GET]
说明 : 获取照片评论数
请求参数:
*photoId:照片ID
是否登录 : 否
缓存时间 : 无
是否分页 : 是
返回结果:
{
replyList:[
{
photoId:照片ID
albumId:相册ID
photoReplyId:评论ID
content:评论内容
createDate:评论时间
userId:评论者ID
nickname:评论者昵称
postToDynaReplyId:被回复的评论ID
postToUserId:被回复的评论发表者ID
postToNickName:被回复的评论发表者昵称
},
{
photoId:照片ID
albumId:相册ID
photoReplyId:评论ID
content:评论内容
createDate:评论时间
userId:评论者ID
nickname:评论者昵称
postToDynaReplyId:被回复的评论ID
postToUserId:被回复的评论发表者ID
postToNickName:被回复的评论发表者昵称
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.14 照片点赞/取消赞
接口:/appapi/1.0/photo/doPraise.do [POST]
说明:照片点赞/取消赞
请求参数
praisePhotoIds:点赞的照片ID(Json格式)
unPraisePhotoIds:取消点赞的照片ID(Json格式)
例子:
praisePhotoIds:[
{"photoId":"111","albumId":"222"},
{"photoId":"111","albumId":"222"}
]
unPraisePhotoIds:[
{"photoId":"111","albumId":"222"},
{"photoId":"111","albumId":"222"}
]
是否登录:是
缓存时间:无
是否分页:否
返回
{
createAt:系统完成操作的时间
failPraisePhotoIds:点赞失败的照片ID(Json格式,跟参数一样)
failUnPraisePhotoIds:取消赞失败的照片ID(Json格式,跟参数一样)
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.15 收到赞我的照片列表
接口:/appapi/1.0/photo/getPraiseList.do [GET]
说明:照片收到的赞列表
请求参数
根据用户登录的Session获取用户ID
是否登录:是
缓存时间:无
是否分页:是
返回
{
praiseList:[
{
userId:用户id
nickName:用户昵称
isVip:是否认证用户(0:未认证,1:已认证)
hadRead:是否已读
praiseTime:点赞时间
photoId:照片id
albumId: 相册ID
urlSmall:照片小图(144x144)
urlBig:照片大图(700x)
},
{
userId:用户id
nickName:用户昵称
isVip:是否认证用户(0:未认证,1:已认证)
hadRead:是否已读
praiseTime:点赞时间
photoId:照片id
albumId: 相册ID
urlSmall:照片小图(144x144)
urlBig:照片大图(700x)
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.16 未读照片点赞清零
接口:/appapi/1.0/photo/clearUnreadPraise.do [POST]
说明:未读照片点赞清零
请求参数
photoIds:照片ID列表(用“,”连接起来)
说明:
1.参数photoIds可选。
2.如果photoIds有传正确照片ID列表,只会对登录用户相应的照片被赞标记为已读。
3.如果photoIds为空值,或者不传参数,将会对登录用户所有未读照片被赞标记为已读。
是否登录:是
缓存时间:无
是否分页:否
返回
{
successPhotoIds:返回被标为已读的照片ID
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.17 获取照片点赞用户列表
接口:/appapi/1.0/photo/getPraiseUserList.do [GET]
说明:获取照片点赞用户列表
请求参数
*photoId:照片ID
是否登录:否
缓存时间:无
是否分页:是
返回
{
userList:[
{
userId:用户id
nickName:昵称
},
{
userId:用户id
nickName:昵称
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.18 判断是否已赞过照片
接口:/appapi/1.0/photo/getHadPraiseList.do [GET]
说明:判断是否已赞过照片
请求参数
*photoIds:照片id列表,用“,”连接起来
是否登录:是
缓存时间:无
是否分页:否
返回
{
hadPraisePhotoIds:返回已经赞过的照片ID,用“,”连接起来
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.2.19 未读照片已赞数
接口:/appapi/1.0/photo/getUnReadCount.do [GET]
说明:未读照片已赞数
请求参数
根据用户登录的Session获取用户ID
是否登录:否
缓存时间:无
是否分页:否
返回
{
praiseNotReadCount:未读已赞的数量
latestPraiseMsg:最新赞我的动态内容(暂定为用户昵称)
latestPraiseTime:最新赞我的时间戳
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3 活动相关
1.3.1 发布/更新活动
接口/appapi/1.0/activity/editActivity.do [POST]
说明 : 发布活动
请求参数:
activityId : 活动ID(如果不传参表示为新建)
*title :活动标题
*activityImgUrl:活动图片(原图URL)
*activityType:类型(1:聚会;2:自驾游;3:线上)
*beginDate:活动开始时间(yyyy-MM-dd HH:mm:ss)
*endDate:活动结束时间(yyyy-MM-dd HH:mm:ss)
*signupDate:报名截止时间(yyyy-MM-dd HH:mm:ss)
money:活动经费
content:活动内容
limitCount:活动人数上限
authorTel:发布者手机号码
contentImages: [ //内容图片
{
url:图片地址(原图URL)
width:宽度
height:高度
description:图片描述
},
{
url:图片地址(原图URL)
width:宽度
height:高度
description:图片描述
}
]
gatherPlace:{ //集合地点
name:名字
longitude:经度
latitude:纬度
markName:别名
}
destinationPlaces:[ //目的地点
{
name:名字
longitude:经度
latitude:纬度
markName:别名
},
{
name:名字
longitude:经度
latitude:纬度
markName:别名
}
]
权限:1.所有车友会友员可进行活动发布
2.只有发起人可以进行修改
活动封面切图:
command=53006--300x200(PC)
command=53031--160x107(PC)
command=53034--600x400(APP)
活动内容切图:
command=53035--600x(限宽600)
是否登录 : 是
缓存时间 : 无
是否分页 : 否
返回结果:
{
activityId : 活动ID
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.2 活动详情
接口/appapi/1.0/activity/getActivityDetail.do [GET]
说明 : 活动详情
请求参数:
*activityId:活动ID
是否登录 : 否
缓存时间 : 无
是否分页 : 否
返回结果:
{
clubId : 车友会ID
activityId : 活动ID
title :活动标题
activityImgUrl:活动图片
activityType:类型(1:聚会;2:自驾游;3:线上)
createBy:发起人ID
userName:发起人名字
nickName:发起人昵称
authorTel:发起人电话号码
createAt : 发布时间
beginDate:活动开始时间
endDate:活动结束时间
signupDate:报名截止时间
money:活动经费
content:活动内容
limitCount 活动人数上限
applyCount : 成功报名人数
activityPlace:活动地点(根据最后一个目的地经纬度返回的城市名,或者显示“线上”)
(下面的需要mrobbot合并)
//statusMsg:状态名字,服务器返回显示火热报名,已报名等状态的文字,app建议直接读取这个新的字段显示
//statusCode:状态码
contentImages: [ //内容图片
{
url:图片地址
width:宽度
height:高度
description:图片描述
},
{
url:图片地址
width:宽度
height:高度
description:图片描述
}
]
gatherPlace:{ //集合地点
name:名字
longitude:经度
latitude:纬度
markName:别名
}
destinationPlaces:[ //目的地点
{
name:名字
longitude:经度
latitude:纬度
markName:别名
},
{
name:名字
longitude:经度
latitude:纬度
markName:别名
}
]
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.3 活动列表
接口:/appapi/2.0/activity/getActivityList.do [GET]
说明 : 车友会活动列表接口
请求参数:
clubId:车友会ID
clubUrl: 车友会域名
userId:用户Id(可选参数)
说明:1.参数clubId,clubUrl不可以同时为空值;
2.如果参数clubId,clubUrl都传值,以clubId为准进行查找。
是否登录:否
缓存时间:无
是否分页:是
返回结果:
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
clubId: 车友会ID
clubUrl:车友会URL
clubName: 车友会名字
data:[
{
activityId:活动ID
activityType:类型(1:聚会;2:自驾游;3:线上)
title:活动标题
signupDate:报名截至时间
endDate:活动截至时间
pic:活动封面图
beginDate:活动开始时间
limitCount:人数限制
createBy : 发布者ID
nickName : 发布表昵称
activityCost:活动费用
dayCount : 活动天数
activityPlace:活动地点(根据最后一个目的地经纬度返回的城市名,或者显示“线上”)
applyCount : 成功报名人数
(下面的需要mrobbot合并)
//isSignUp:是否报名
//statusMsg:状态名字,服务器返回显示火热报名,已报名等状态的文字,app建议直接读取这个新的字段显示
//statusCode:状态码
//applyCount:申请人数(包括审核中,通过审核的)
}
]
}
1.3.4 获取活动状态提示
接口:/appapi/1.0/activity/getActivityStatus.do [GET]
说明 : 获取活动状态提示
请求参数:
*activityId : 活动ID
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
activityId : 活动ID
statusMsg:活动状态描述
statusCode:状态码
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
备注:
101:报名结束(人数限制) 102:活动结束 103:活动进行中
104:报名结束(时间限制) 105:火热报名
(下面的需要mrobbot合并)
//201:审核中 202:已报名
1.3.5 判断用户是否已报名
接口:/appapi/1.0/activity/hasApplyed.do [GET]
说明 : 判断用户是否已报名
请求参数:
*activityId : 活动ID
*userId : 用户ID
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
activityId:活动ID
userId:用户ID
isSignup:是否报名 (0:审核中, 1:报名成功,2:未报名)
isSignupMsg:是否报名提示信息
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.6 删除活动
接口:/appapi/1.0/activity/delActivity.do[POST]
说明 : 删除活动
请求参数:
*activityId : 活动ID
权限:发布者,会长,副会长
是否登录:是
缓存时间:无
是否分页:否
返回结果:
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.7 活动报名
接口:/appapi/1.0/activity/applyActivity.do[POST]
说明 : 活动报名
请求参数:
*activityId : 活动ID
*name:名字
*phone:电话
joinNum:报名人数
lincensePlate:车牌
descript:描述
isDriving:是否自驾车(0:否;1:是, 默认为1)
权限:车友会会员
是否登录:是
缓存时间:无
是否分页:否
返回结果:
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.8 活动审核
接口:/appapi/1.0/activity/auditApply.do[POST]
说明 : 活动审核
请求参数:
*activityId : 活动ID
*userId : 用户ID
*action : 操作类型 1:通过,-1:拒绝
权限:发布者
是否登录:是
缓存时间:无
是否分页:否
返回结果:
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.9 活动报名列表(审核中)
接口:/appapi/1.0/activity/getApplyingList.do[GET]
说明 : 活动报名列表
请求参数:
*activityId : 活动ID
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
activityId : 活动ID
total: 待审核报名人数
apply:[{
userName :报名名字
nickName : 会员昵称
joinNum : 报名参加人数
phone : 联系电话
descript : 报名描述
lincensePlate : 车牌
userId : 用户ID
memberId : 会员ID
isDriving:是否自驾车(0:否;1:是)
}],//申请人列表
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.10 活动报名列表(审核通过)
接口:/appapi/1.0/activity/getApplyedList.do[GET]
说明 : 活动报名列表
请求参数:
*activityId : 活动ID
是否登录:否
缓存时间:无
是否分页:是
返回结果:
{
activityId : 活动ID
total:报名通过人数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
data:[{
userName : 报名名字
nickName : 会员昵称
joinNum : 报名参加人数
phone : 联系电话
descript : 报名描述
lincensePlate : 车牌
userId : 用户ID
memberId :会员ID
isDriving:是否自驾车(0:否;1:是)
}]//已报名列表
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.11 判断活动是否生成过动态(旧数据没有评论功能)
接口:/appapi/1.0/activity/hasDynaByActivityId.do[GET]
说明 : 活动报名列表
请求参数:
*activityId : 活动ID
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
activityId : 活动ID
dynaInfoId : 动态ID (0:没有动态;大于0:有动态)
replyCount : 活动评论数
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.3.12 取消活动报名
接口:/appapi/1.0/activity/cancelActivity.do[POST]
说明 : 取消活动报名
请求参数:
*activityId : 活动ID
是否登录:是
缓存时间:无
是否分页:否
返回结果:
{
activityId : 活动ID
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4 首页相关接口
1.4.1 今日签到排行列表
接口:/appapi/1.0/club/todayCheckInList.do[GET]
说明 : 今日签到排行列表=
请求参数:
*clubId: 车友会ID
是否登录:否
缓存时间:无
是否分页:是
返回结果:
{
checkInList : [
{
userId : 签到者ID
nickName : 签到者昵称
checkInTime : 签到时间(时间戳)
},
{
userId : 签到者ID
nickName : 签到者昵称
checkInTime : 签到时间(时间戳)
}
]
total:报名通过人数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4.2 设置动态置顶
接口:/appapi/1.0/dyna/setDynaTop.do[POST]
说明 : 设置动态置顶
请求参数:
*dynaInfoId : 动态ID
是否登录:是
缓存时间:无
是否分页:否
返回结果:
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4.3 取消动态置顶
接口:/appapi/1.0/dyna/cancelDynaTop.do[POST]
说明 : 取消动态置顶
请求参数:
*dynaInfoId : 动态ID
是否登录:是
缓存时间:无
是否分页:否
返回结果:
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4.4 获取动态置顶列表
接口:/appapi/1.0/dyna/dynaTopList.do[GET]
说明 : 获取动态置顶列表
请求参数:
*clubId: 车友会ID
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
dynaTopList : [
{
dynaInfoId : 动态ID
dynaType : 动态类型
content: 动态内容(图片用【图】代替)
dynaTargetId : 动态目标ID
pubTime : 动态发表时间
},
{
dynaInfoId : 动态ID
dynaType : 动态类型
content: 动态内容(图片用【图】代替)
dynaTargetId : 动态目标ID
pubTime : 动态发表时间
}
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4.5 获取车友会动态列表(包括动态图片列表)
说明:获取动态列表(返回动态图片列表)
接口:/appapi/2.0/dyna/getDynaListImages.do [GET]
请求参数
*clubId:车友会id
是否登录:否
缓存时间:无
是否分页:是
返回
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
dynaList:[
{
dynaInfoId:动态id,
postCount:回复数
pubTime: 发布时间,
forumId: 板块ID,
forumName: 板块名称,
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:是)
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
}
]
}
]
}
1.4.6 帖子列表(发布时间倒序)
接口:/appapi/1.0/topic/topicListByCreateTime.do[GET]
说明 : 帖子列表(发布时间倒序)
请求参数:
*clubId: 车友会ID
是否登录:否
缓存时间:无
是否分页:是
返回结果:
{
topicList : [
{
author : {
realName : 真实名字
nickName : 昵称
userId : 发贴人ID
}
createAt : 发贴时间
isPic : 是否有图片 1:有, 0:无
isPick : 是否精华 1:有, 0:无
isRecommend : 是否推荐 1:有, 0:无
lastPostAt : 最新回复时间
replyCount : 回复数
title : 帖子标题
topicId : 帖子ID
url : 帖子URl
//viewCount : 阅读数(由论坛提供接口 参考1.4.8)
},
{
author : {
realName : 真实名字
nickName : 昵称
userId : 发贴人ID
}
createAt : 发贴时间
isPic : 是否有图片 1:有, 0:无
isPick : 是否精华 1:有, 0:无
isRecommend : 是否推荐 1:有, 0:无
lastPostAt : 最新回复时间
replyCount : 回复数
title : 帖子标题
topicId : 帖子ID
url : 帖子URl
//viewCount : 阅读数(由论坛提供接口 参考1.4.8)
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4.7 帖子列表(回复时间倒序)
接口:/appapi/1.0/topic/topicListByPostTime.do[GET]
说明 : 帖子列表(回复时间倒序
请求参数:
*clubId: 车友会ID
是否登录:否
缓存时间:无
是否分页:是
返回结果:
{
topicList : [
{
author : {
realName : 真实名字
nickName : 昵称
userId : 发贴人ID
}
createAt : 发贴时间
isPic : 是否有图片 1:有, 0:无
isPick : 是否精华 1:有, 0:无
isRecommend : 是否推荐 1:有, 0:无
lastPostAt : 最新回复时间
replyCount : 回复数
title : 帖子标题
topicId : 帖子ID
url : 帖子URl
//viewCount : 阅读数(由论坛提供接口 参考1.4.8)
},
{
author : {
realName : 真实名字
nickName : 昵称
userId : 发贴人ID
}
createAt : 发贴时间
isPic : 是否有图片 1:有, 0:无
isPick : 是否精华 1:有, 0:无
isRecommend : 是否推荐 1:有, 0:无
lastPostAt : 最新回复时间
replyCount : 回复数
title : 帖子标题
topicId : 帖子ID
url : 帖子URl
//viewCount : 阅读数(由论坛提供接口 参考1.4.8)
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4.8 获取帖子被查看次数(由论坛提供)
接口:${BBSROOT}/clubapi/1/getTopicView.do[GET]
说明 : 获取帖子被查看次数(由论坛提供)
请求参数:
*tids: 帖子ID(“,”连接)
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
topicViews: [
{
tid: 帖子ID
view : 阅读数
},
{
tid: 帖子ID
view : 阅读数
}
]
code:0成功,-1失败
message:提示信息
}
1.4.9 删除动态
接口:/appapi/1.0/dyna/deleteDyna.do[POST]
说明 : 删除动态
请求参数:
*dynaInfoId: 车友会ID
是否登录:是
缓存时间:无
是否分页:否
返回结果:
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4.10 获取帖子被查看次数/对应论坛/评论数(由论坛提供)
接口:${BBSROOT}/intf/topics.do[GET]
说明 : 获取帖子被查看次数/对应论坛/评论数(由论坛提供
请求参数:
*tids: 帖子ID(“,”连接)
例子:http://bbs.pcauto.com.cn/intf/topics.do?tids=5362127
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
[
{
tid: 帖子ID
view: 阅读数
replyCount:评论数
},
{
tid: 帖子ID
view : 阅读数
replyCount:评论数
}
]
code:0成功,-1失败
message:提示信息
}
1.4.11 获取同城动态列表
说明:获取同城动态列表
接口:/appapi/2.0/dyna/getTongChengDynaList.do [GET]
请求参数:
*provinceId 发动态省地区id(必选)
cityId 发动态市地区id(无则不传)
是否登录:否
缓存时间:无
是否分页:是
返回
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
dynaList:[
{
dynaInfoId:动态id,
postCount:回复数
pubTime: 发布时间,
forumId: 板块ID,
forumName: 板块名称,
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:是)
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
}
]
}
]
}
1.4.12 同城优惠列表
接口:/appapi/2.0/club/listTongChengYouhui.do [GET]
说明:同城优惠列表
请求参数
*provinceId 发动态省地区id(必选)
cityId 发动态市地区id(无则不传)
是否登录:否
缓存时间:无
是否分页:是
返回
{
tongChengYouhuiData:[
{
endTime = 1415030400000;
img:图片
startTime = 1412092800000;
time:时间
title:标题
topicUrl:http://bbs.pcauto.com.cn/topic-5460623.html 帖子url
},
{
endTime = 1415030400000;
img:图片
startTime = 1412092800000;
time:时间
title:标题
topicUrl:http://bbs.pcauto.com.cn/topic-5460623.html 帖子url
}
]
total:总条数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.4.13 获取动态详情接口
说明:获取动态
接口:/appapi/2.0/dyna/getDynaDetail.do [GET]
请求参数
*dynaInfoId:动态id
*createBy:动态创建者id
是否登录:否
缓存时间:无
是否分页:否
返回
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
dynaDetail:[
{
postCount:回复数
pubTime: 发布时间,
authorId: 作者ID,
forumId: 16160,
authorName: 作者名称,
nickname:作者昵称,
contribution: 贡献油值,
dynaInfoId,动态ID
authorPhoto: 作者头像,
isRecommend: 是否是推荐,
content:动态内容
isVip:是否认证 (0:未认证,1:已认证)
praiseCount:点赞数,
images:[
{
url:http://xxxx.jpg,
//真实宽度
width:960,
//真实高度
height:1000,
//质量参数,默认为0,10月上线
qua:80
},
{
url:http://xxxx.jpg,
//真实宽度
width:960,
//真实高度
height:1000,
//质量参数,默认为0,10月上线
qua:80
}
]
}
]
}
1.4.14 从动态详情删除动态
接口:/appapi/1.0/dyna/deleteDynaFromDetail.do[POST]
说明 : 删除动态
请求参数:
*dynaInfoId: 动态ID
是否登录:是
缓存时间:无
是否分页:否
返回结果:
{
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
1.5 PV相关接口
1.5.1 添加车友会pv
接口:/appapi/1.0/club/addVisitorPv.do [POST]
说明 : 添加车友会pv
请求参数:
*clubId: 车友会ID
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
code : 0成功,-1失败
message : 提示信息
version : 接口版本号如1.0,1.0(latest)表示最新版本
}
接口调用时机(APP端统计规则):
1、启动APP,按HOME键退出后重新进入,PV+1,调用1次接口
2、车友会主页,下拉刷新 PV+1,调用1次接口
3、动态页面,点击进入 PV+1,调用1次接口
4、相册列表,点击进入或者下拉 PV+1,调用1次接口
5、活动列表,点击进入或者下拉 PV+1,调用1次接口
6、活动终端,点击进入或者下拉 PV+1,调用1次接口
7、论坛列表,点击进入或者下拉 PV+1,调用1次接口
8、从其他频道(非车友会内的页面)返回车友会,PV+1,调用1次接口
2. 车友会app批量接口
2.1 活动相关
2.1.1 批量获取活动列表的状态提示
接口:/appapi/2.0/activity/getActivityStatus.do [GET]
说明 : 批量获取活动列表的状态提示
请求参数:
*activityIds : 活动ID,使用“,”连接在一起
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
data:[{
activityId : 活动ID
statusMsg:活动状态描述
statusCode:状态码
},{
activityId : 活动ID
statusMsg:活动状态描述
statusCode:状态码
}
]
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
备注:
101:报名结束(人数限制) 102:活动结束 103:活动进行中
104:报名结束(时间限制) 105:火热报名
(下面的需要mrobbot合并)
//201:审核中 202:已报名
2.1.2 批量获取用户活动的报名情况
接口:/appapi/2.0/activity/hasApplyed.do [GET]
说明 : 批量获取用户活动的报名情况
请求参数:
*activityIds : 活动ID,使用“,”连接在一起
*userId : 用户ID
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
data:[{
activityId:活动ID
userId:用户ID
isSignup:是否报名 (0:审核中, 1:报名成功,2:未报名)
isSignupMsg:是否报名提示信息
},{
activityId:活动ID
userId:用户ID
isSignup:是否报名 (0:审核中, 1:报名成功,2:未报名)
isSignupMsg:是否报名提示信息
}
]
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
2.1.3 批量获取活动列表的报名列表(审核中)
接口:/appapi/2.0/activity/getApplyingList.do [GET]
说明 : 批量获取活动列表的报名列表(审核中)
请求参数:
*activityIds : 活动ID,使用“,”连接在一起
*clubId : 车友会id
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
data:[{
activityId : 活动ID
total: 待审核报名人数
apply:[{
userName :报名名字
nickName : 会员昵称
joinNum : 报名参加人数
phone : 联系电话
descript : 报名描述
lincensePlate : 车牌
userId : 用户ID
memberId : 会员ID
isDriving:是否自驾车(0:否;1:是)
}],//申请人列表
}]
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
2.1.4 批量获取活动列表的报名列表(审核通过)
接口:/appapi/2.0/activity/getApplyedList.do[GET]
说明 : 批量获取活动列表的报名列表(审核通过)
请求参数:
*activityIds : 活动ID,使用“,”连接在一起
*clubId : 车友会id
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
data:[{
activityId : 活动ID
total:报名通过人数
pageNo:页码
pageSize:每页条数
pageCount:总共几页
applyed:[{
userName : 报名名字
nickName : 会员昵称
joinNum : 报名参加人数
phone : 联系电话
descript : 报名描述
lincensePlate : 车牌
userId : 用户ID
memberId :会员ID
isDriving:是否自驾车(0:否;1:是)
}]//已报名列表
}]
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
3. 动态切图接口
3.1 动态切图相关
3.1.1 相册照片动态切图
接口:/appapi/1.0/photo/getPhotoUpcComm.do [GET]
说明 : 相册照片动态切图
请求参数:
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
commands:切图命令
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
3.1.2 活动封存动态切图
接口:/appapi/1.0/activity/getCoverUpcComm.do [GET]
说明 : 活动封存动态切图
请求参数:
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
commands:切图命令
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}
3.1.3 活动内容图片动态切图
接口:/appapi/1.0/activity/getContentUpcComm.do [GET]
说明 : 活动内容图片动态切图
请求参数:
是否登录:否
缓存时间:无
是否分页:否
返回结果:
{
commands:切图命令
code:0成功,-1失败
message:提示信息
version: 接口版本号如1.0,1.0(latest)表示最新版本
}