[[PageOutline(1-100,接口索引)]] == 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时，为修改相册，否则为创建相册 是否登录 : 是 缓存时间 : 无 是否分页 : 否 返回结果： { code : 0成功，-1失败 message : 提示信息 version : 接口版本号如1.0，1.0（latest)表示最新版本 } }}} ==== 1.2.2 上传图片 ==== {{{ 接口/appapi/1.0/album/uploadPhotos.do [POST] 说明 : 上传图片 请求参数： *albumId：相册ID *photoList : [ { name : 图片名字 url : 图片URL }, { name : 图片名字 url : 图片URL } ] 是否登录 : 是 缓存时间 : 无 是否分页 : 否 返回结果： { code : 0成功，-1失败 message : 提示信息 version : 接口版本号如1.0，1.0（latest)表示最新版本 } }}} ==== 1.2.3 设置封面 ==== {{{ 接口/appapi/1.0/album/setAlbumCover.do [POST] 说明 : 设置封面 请求参数： *albumId: 相册ID *newCoverUrl: 新封面URL 备注：根据登录信息获取车友会信息 是否登录 : 是 缓存时间 : 无 是否分页 : 否 返回结果： { 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 : 是否认证 photoList : [ { photoId : 照片ID createBy : 上传者ID urlSamll : 小图片 urlBig : 大图片 }, { photoId : 照片ID createBy : 上传者ID urlSamll : 小图片 urlBig : 大图片 } ] 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 : 封面图片 createAt : 相册创建时间 createBy : 相册创建者 nickName : 创建者昵称 authorPhoto : 创建者头像 isVip : 是否认证 photoSize : 相片数 photoList : [ { photoId : 照片ID urlSamll : 小图片 urlBig : 大图片 }, { photoId : 照片ID urlSamll : 小图片 urlBig : 大图片 } ] }, { albumId : 相册ID albumName : 相册名字 coverUrlSmall : 封面图片 createAt : 相册创建时间 createBy : 相册创建者 nickName : 创建者昵称 authorPhoto : 创建者头像 isVip : 是否认证 photoSize : 相片数 photoList : [ { photoId : 照片ID urlSamll : 小图片 urlBig : 大图片 }, { photoId : 照片ID urlSamll : 小图片 urlBig : 大图片 } ] } ] 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 urlSamll : 小图片 urlBig : 大图片 createAt : 照片创建时间 }, { albumID : 相册ID photoId : 照片ID urlSamll : 小图片 urlBig : 大图片 createAt : 照片创建时间 } ] total:总条数 pageNo:页码 pageSize:每页条数 pageCount:总共几页 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 活动人数上限 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:活动地点（根据最后一个目的地经纬度返回的城市名，或者显示“线上”） (下面的需要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 描述 权限：车友会会员 是否登录:是 缓存时间:无 是否分页:否 返回结果： { 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 }],//申请人列表 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:[{ name : 报名名字 nickname : 会员昵称 joinNum : 报名参加人数 phone : 联系电话 descript : 报名描述 lincensePlate : 车牌 userId : 用户ID memberId :会员ID }]//已报名列表 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：有动态） code:0成功，-1失败 message:提示信息 version: 接口版本号如1.0，1.0（latest)表示最新版本 } }}} {{{ #!html
返回
顶部
}}}