wiki:pcauto_club_2.0.0/api

Version 128 (modified by xieweijie, 12 years ago) (diff)

文档同步

Table of Contents

  1. 1.基本约定
  2. 2.接口列表
    1. 2.1 车友会详情接口
    2. 2.2车友会信息与已加入的车友会权限列表接口
    3. 2.3首页车友会列表接口
    4. 2.4车友会搜索接口
    5. 2.5车友动态接口
    6. 2.6车友会相册列表接口
    7. 2.7相册图片列表接口
    8. 2.8上传图片接口
    9. 2.9创建相册接口
    10. 2.10车友会活动列表接口
    11. 2.11活动详情与报名人员名单接口
    12. 2.12活动报名接口
    13. 2.13车友会成员列表接口
    14. 2.14车友会成员管理接口
    15. 2.15车友会入会接口
    16. 2.16车友会留言列表接口
    17. 2.17创建留言与回复留言接口
    18. 2.18创建车友会接口
    19. 2.19修改车友会接口
    20. 2.20域名合法校验接口
    21. 2.21车友会名合法校验接口
    22. 2.22获取手机验证码接口
    23. 2.23中国车友会管理条例页面
    24. 2.24车友会签到接口
    25. 2.25编辑推荐论坛接口
    26. 2.26论坛新帖数与新帖标题接口
    27. 2.27论坛相关车友会接口
    28. 2.28同城车友会列表接口
    29. 2.29车友会排行榜接口
    30. 2.30 取消活动报名接口
    31. 2.31 获取城市列表
    32. 2.32 根据IP获取城市ID
    33. 2.33 入会审核接口
    34. 2.34 获取论坛最新帖子接口
    35. 2.34（编号重复了，注意一下） 获取用户已参加活动列表接口
    36. 2.35 图片上传接口
    37. v2.1.0新增
    38. 2.36 ip获取地区接口
    39. 2.37 活动审核列表
    40. 2.38 活动审核操作（通过、拒绝）
    41. 2.39 发现首页活动焦点图(CMS)
    42. 2.40 热门活动日记
    43. 2.41 获取车友会操作权限(报名 创建)
    44. 2.42 判断能否申请加入活动(只有申请加入活动才调用)
    45. 2.43 推送设置接口
    46. 3.1 IM获取token
    47. 3.2 IM获取好友列表
    48. 4.1车友动态接口
    49. 4.2 发动态
    50. 4.3修改个人信息
    51. 4.4 回复动态
    52. 4.5 动态回复列表
    53. 4.6个人中心帖子列表

1.基本约定

通用接口请求参数:
req_enc=utf-8  					请求参数编码
resp_enc=utf-8 					响应返回编码
common_session_id=xxxx 			用户登录凭证,如果接口需要登陆则生效
pageNo=1		 			请求页码(>=1),如果接口返回有分页处理则生效
pageSize=20	 				请求页长度,默认20,如果接口返回有分页处理则生效

通用接口返回参数:
total:18						返回记录总条数,如果接口返回有分页处理则生效
pageNo:1						返回页码(>=1),如果接口返回有分页处理则生效
pageSize:20					返回页长度,如果接口返回有分页处理则生效

测试接口前缀:http://dev18.pcauto.com.cn:8003
上线接口前缀:http://club.pcauto.com.cn

名词解释
接口URL:   接口URL
接口说明:	描述接口的应用场景
请求参数：参数名=xxx
是否登录：是|否,表示接口是否要登陆才能访问
是否分页:  是|否,表示返回的列表有分页处理
缓存时间：xx,设置Response Http Headers Cache-Control:max-age=xx(单位/秒)
返回结果：成功返回结果示例

全局接口返回格式：json

全局接口错误格式:
{
	code:0			//错误代码,0:正常返回 1:操作失败 1001:权限类错误 1002:数据类错误 1003:用户无登陆
	message: “您还没有登陆”		//错误提示
}

2.接口列表

2.1 车友会详情接口

整合到:2.4车友会搜索接口
根据车友会ID返回车友会详情

获取车友会二维码接口
http://车友会域名/util/clubQrCode.jsp?clubId=车友会id

2.2车友会信息与已加入的车友会权限列表接口

接口URL:/club/getJoinedClubList.do
说明:获取车友会信息与已加入的车友会权限列表

请求参数：
uid:用户ID，如果不传，默认是当前登录用户ID

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

返回结果：
{"data":[
 {
 "clubId":车友会ID,
 "clubStatus":车友会状态（是否被锁之类）
 "name":车友会名称,
 "logo":logo的URL,
 "introduce":简介,
 "brandId":品牌ID,
 "brandName":品牌名称,
 "seriesId":车系ID
 "seriesName":车系名称,
 "cityId":城市ID,
 "cityName":城市名称,
 "provinceId":省份ID,
 "provinceName":省份,
"rank":全国排名，为0时，表示暂时没有排名,
 "reginRank":区排名，为0时，表示暂时没有排名,
 "memberNum":会员总人数,
 "vipNum":认证总人数,
 "totalPetrol":总油值,
 "level":等级ID,
 "addressPhone":收货地址——联系号码,
 "addressUserName":收货地址——联系人,
 "addressProvinceId":收货地址——省份ID,
 "addressProvinceName":收货地址——省份名称,
 "addressCityId":收货地址——城市ID,
 "addressCityName":收货地址——城市名称,
 "addressDetail":收货地址——详细地址,
 "addressPostcode":收货地址——邮编,
 "adminType":成员角色
"memberId":会员ID
"userName":用户名称
"userNikeName":用户昵称
"userPhone":用户电话
"userCar":用户爱车
"userProvince":用户所在省
"userCity":用户所在市
"userGener":用户性别，性别,0:男,1:女
}
]
}
adminType说明:-3->当前车友会审核当中 -2->加入其他或者其他车友会审核当中 -1->游客 0->普通会员 1->副会长 2->会长,

2.3首页车友会列表接口

接口URL:/club/getClubByUIdOrRegionId.do
说明:如果用户已登陆并且有加入车友会则返回用户已加入的车友会列表,否则根据IP地址判断用户所在地,并返回所在地车友会列表

请求参数：
userId (可选参数)
provinceId:地区id
cityId:地区id（只有一层，如澳门，只传的provinceId）

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

返回结果：
{
    "userId": 用户ID[地区ID], 
    //已加入车友会数据
    "data": [
             {
            "logo": 车友会会标
            "clubStatus":车友会状态（是否被锁之类）0未审核 1已审核 2拒绝 3被封 4锁定
            "announcement": 公告, 
            "memberSum": 成员数, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce": 简介, 
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId":用户ID,
            "clubUrl":车友会域名,
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "brandName": 品牌名称,
            "regionRank": 品牌排名, 
            "rank":全国排名，
            "activitySum": 活动数, 
            "name":车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数,
            "photoSum":照片数
            "activityName": 最新活动名称
            "memberId":会员ID,如果有
            “adminType”:成员角色//说明参考2.2
            "isCheck": true/false 是否签到
           }
    ],
//推荐数据
    "recommendData": [
             {
            "logo": 车友会会标
            “ clubStatus”:车友会状态
            "announcement": 公告, 
            "memberSum": 成员数, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce": 简介, 
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId":用户ID,
            "clubUrl":车友会域名,
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "brandName": 品牌名称,
            "regionRank": 品牌排名, 
            "rank":全国排名，
            "activitySum": 活动数, 
            "name":车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数,
            "photoSum":照片数
            "activityName": 最新活动名称
           }
    ],
//审核中车友会
    “applyData”:[
	{
	"logo": 车友会会标
        "clubStatus":车友会状态（是否被锁之类）
            "announcement": 公告, 
            "memberSum": 成员数, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce": 简介, 
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId":用户ID,
            "clubUrl":车友会域名,
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "brandName": 品牌名称,
            "regionRank": 品牌排名, 
            "rank":全国排名，
            "activitySum": 活动数, 
            "name":车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数,
            "photoSum":照片数
            "activityName": 最新活动名称
            "memberId":会员ID,如果有
            “adminType”:成员角色//说明参考2.2
            ”isCheck“:true/false 是否签到
	}
    ]
}

2.4车友会搜索接口

接口URL:/club/getClubByCityOrRegionId.do
说明:搜索,精确查找,根据id查找

请求参数：
provinceId:省id
cityId:城市ID（无则无须传cityid）
brandId:品牌id
seriesId:车系ID
clubName:车友会名称
clubId:车友会ID
userId:用户ID(可选)

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

返回结果：
"data": [
             {
            "logo": 车友会会标
            "announcement": 公告, 
            "memberSum": 成员数, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce": 简介, 
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId":用户ID,
            "clubStatus":车友会状态（是否被锁之类）
            "clubUrl":车友会域名,
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "brandName": 品牌名称,
            "regionRank": 品牌排名, 
            "rank":全国排名，
            "activitySum": 活动数, 
            "name":车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数,
            "photoSum":照片数
            "activityName": 最新活动名称
            "memberId":会员ID,如果有
	    "adminType":成员角色//说明参考2.2
            "isCheck":true/false 是否签到
            "forumId":论坛id，用于发帖
           }
    ]

2.5车友动态接口

接口URL:/topic/listTopicByClubId.do
说明:根据车友会ID,返回车友动态列表

请求参数：
clubId:车友会ID
imagesType:1//图片返回形式，1.2.0需求修改，兼容旧版本，加参数判断，为1时返回参数增加下面这个字段，里面是数组，旧的image1 image2 image3字段的无须返回，不传或其他情况需要返回该3个字段

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

返回结果：
{
    "clubId": clubId, 
    "data": [
             {
             "postCount":回复数
	     "pubTime": 发布时间, 
            "topicTitle": 帖子标题, 
            "forumName": 板块名称, 
            "isPick": 是否是精华, 
            "authorId": 作者ID, 
            "isHasImg": 是否有图片, 
            "image2": 第二张图, 
            "image1": 第一张图, 
            "forumId": 16160, 
            "authorName": 作者名称, 
            "nickname":作者昵称,
            "contribution": 贡献油值, 
            "topicId": 帖子ID, 
            "authorPhoto": 作者头像, 
            "image3": 第三张图, 
            "isRecommend": 是否是推荐,
            "images":[
		{
			“url”:http://xxxx.jpg,
			//真实宽度
			“width”:960,
			//真实高度
			“height”:1000
		},
                {
			“url”:http://xxxx.jpg,
			//真实宽度
			“width”:960,
			//真实高度
			“height”:1000
		}
	        ]
           }
	]
}

2.6车友会相册列表接口

接口URL:/album/getAlbumByClubId.do
说明:根据车友会ID,返回相册列表

请求参数：
clubId:车友会ID
userId (可选参数)

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

返回结果:
{
    "clubId": 车友会ID, 
    "clubName": 相册名称,
    “adminType”:成员角色//说明参考2.2
    "data": [
            {
            "photos":[
                {
                "urlsmall":"http://dev2.pconline.com.cn:9191/autoclub/1403/27/c0/1195694_1395912475624_160x120.jpg",
                "urlbig":"http://dev2.pconline.com.cn:9191/autoclub/1403/27/c0/1195694_1395912475624_700.jpg"
                }],
            "albumName":"默认相册",
            "albumId":171,
            "photoSize": 相片数,
            "coverurlsmall":"http://dev2.pconline.com.cn:9191/autoclub/1403/27/c0/1195694_1395912475624_160x120.jpg",//封面图片
            }
    ]
}

2.7相册图片列表接口

接口URL:/album/getPhotoByAlbumId.do
说明:根据相册ID返回相片列表

请求参数：
albumId:相册ID
userId (可选参数)

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

返回结果：
{
"albumId": 相册ID, 
"albumName": 相册名称, 
“adminType”:成员角色//说明参考2.2
"data": [
     {
     "urlsmall":小图地址，
     "urlbig":大图地址
     }
      ]
}

2.8上传图片接口

接口URL:/album/uploadPic.do
说明:上传图片到车友会指定相册

请求参数：
albumId:相册ID
userId:用户id，从登录信息取
urls : 格式:名称@路径，多张图片以”,”分割(上传原图url)

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

返回结果：
{code:0}

2.9创建相册接口

接口URL:/album/updateSaveAlbum.do
说明:创建(修改)相册名称

请求参数：
clubId：车友会ID
userId：用户ID，从登录信息取
albumId:相册ID[若有ablumId，则为修改，为0，则为创建]
name；相册名称

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

返回结果：
{
code:0,
message:失败描述
albumId:相册ID
}

2.10车友会活动列表接口

接口URL:/activity/listActivityByClubId.do
说明:根据车友会ID,返回该车友会活动列表

请求参数：
clubId:车友会ID
userId:用户Id（可选参数）

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

返回结果：
{
"clubId": 
"clubName": 
"data":[
        {
        "activityId":活动ID
        "title":活动标题
        "signupDate":报名截至时间
        "endDate":活动截至时间
        "pic":活动封面图
        "place":活动地址
        "beginDate":活动开始时间
        "isSignUp":是否报名
        “limitCount”:人数限制
        “statusMsg”:状态名字，服务器返回显示火热报名，已报名等状态的文字，app建议直接读取这个新的字段显示
        "statusCode":状态码
        }
    ]
}

活动状态码说明
火热报名中    101
报名已结束(人数上限)    102
报名已结束(时间过截止时间)   103
活动进行中  104
活动已结束  105
审核中    201
取消报名  --- 无
已报名  203
活动不存在  100

2.11活动详情与报名人员名单接口

接口URL:/activity/getActivityById.do
说明:返回活动详情及活动报名人员名单

请求参数：
activityId:活动ID
userId(可选参数,如果已登陆)

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

返回结果：
{
    "activityId": 活动ID, 
    “adminType”:成员角色//说明参考2.2
    "memberId":会员Id,
    "clubId":车友会ID,
    "content":活动内容, 
    "createAt": 创建时间, 
    "title": 活动标题, 
    "signupDate": 报名截止时间, 
    "money": 活动费用, 
    "isSignUp"：是否报名,
    "place": 活动地点, 
    "createBy": 创建者, 
    "endDate": 活动结束时间, 
    "beginDate": 活动开始时间，
    “limitCount”:人数限制
    “statusMsg”:状态名字，服务器返回显示火热报名，已报名等状态的文字，app建议直接读取这个新的字段显示
    “statusCode”:活动状态code//参考2.10    
    “applysCount”:待审核人员数
    "data":[
        {
        “userId”:用户id
        "name":用户名称
        "nickname":用户昵称
        "joinNum":参加人数
        "phone":联系电话
        "pic":头像
        "lincensePlate":车牌号
        "descript"：备注信息
        }
    ]
}

2.12活动报名接口

接口URL:/activity/applyActivity.do
说明:活动报名

请求参数：
activityId:活动ID
userId：用户ID，从登录信息中取
name；真实姓名
phone：联系电话
joinNum：参加人数
lincensePlate；车牌号
descript：备注信息


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

返回结果：
{code:0}

2.13车友会成员列表接口

接口URL:/member/getMemberByClubId.do
说明:获取车友会成员列表接口

请求参数：
clubId:车友会ID
isShowAdmin:1 //1 区分管理和会员，0 不区别，建议是用0

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

返回结果：
{
    "clubId": 车友会ID, 
    “adminType”:成员角色//说明参考2.2
    "admins": [{管理员
            "name": 用户名称, 
            "nickname":用户昵称,
            "truename":申请真实姓名,
            "userId": 用户ID, 
            "memberId": 用户ID, 
            "type": 用户类别[0：会员，1：副会长，2，会长]
            "photo": 用户头像地址 
            "phone":电话号码
            "vipInfo":爱车
            "province":省份
            "city":城市
        }], 
    "members": [{普通会员,分页在此生效
            "name": 用户名称,
            "nickname":用户昵称, 
            "truename":申请真实姓名,
            "userId": 用户ID, 
            "memberId": 用户ID, 
            "type": 用户类别[0：会员，1：副会长，2，会长]
            "photo": 用户头像地址 
            "phone":电话号码
            "vipInfo":爱车
            "province":省份
            "city":城市
        }],
   "applys": [待审核人员
        {
            "name": "申请人名称",
            "nickname":用户昵称,
            "truename":申请真实姓名,
            "userId": 申请人ID,
            "memberId": 用户ID, 
            "photo":申请人头像
            "phone":电话号码
            "vipInfo":爱车
            "province":省份
            "city":城市
      }]
}

2.14车友会成员管理接口

接口URL:/member/operation.do 
说明:车友会成员管理

请求参数：
clubId：车友会ID
targetId：操作用户memberId,如果操作者自己的memberId,并且type=4则表示退出该车友会,type=5表示取消审核中车友会申请
type:操作类型，1--转让会长，2--设置副会长，3--解除职务，4--移除车友会 5--取消审核中车友会申请

type=5时，targetId为用户id

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

返回结果：
{code:0}

2.15车友会入会接口

接口URL:/member/apply.do
说明:加入车友会

请求参数：
clubId;车友会ID
truename:真实姓名
gender：性别(0:男,1:女)
provinceName:省
cityName:市
phone:联系电话
brand:品牌ID
serial:车系ID
brandName:品牌名称
serialName：车系名称

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

返回结果：
{
status:-1>处理错误  0>成功  1>没有权限，没有登录  2>参数错误 3>不符合处理条件
desc:信息提示
}

2.16车友会留言列表接口

接口URL:/comment/listCommentByUserClubId.do
说明:获取车友会最新留言与我的留言

请求参数：
clubId：车友会ID
targetId：用户id(可选，如果传入，则为该用户的留言，不传入，则为车友会留言，区分下面的字段)
备注：请求用户信息从cookies里面获取

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

返回结果：
{
“adminType”:成员角色//说明参考2.2
"data": [
           {
             "msgId":ID
	    "image1big":图片1大图,
            "image2small": 图片2小图,
            "image1small":图片1小图,
            "createAt": 发表留言时间,
            "image2big": 图片2,
            "userId": 用户ID,
            "userName": 用户姓名,
            "msg": 留言信息,
            "replays": [
                  {
	          "replayId":回复ID, 
                  "replyUserId":回复用户ID, 
                  "replayName": 回复人名称, 
                  "replayContent":回复内容, 
                  "createAt": 回复时间, 
                  "image1big": 图片1大图, 
                  "image2big": 图片2大图, 
                  "image1small": 图片1小图, 
                  "image2small": 图片2小图,
                  }
	      ]
           }
	],
    "clubId": 车友会ID,
    "clubName": 车友会名称
}

2.17创建留言与回复留言接口

接口URL:/comment/addComment.do
说明:创建与回复留言

请求参数：
clubId:车友会ID
content:回复内容
replyId:回复留言的ID(可选)
imgUrl1 :上传图片1(可选)
imgUrl2 : 上传图片2(可选)

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

返回结果：
{code:0}

2.18创建车友会接口

接口URL:/club/createClub.do
说明:创建车友会接口

请求参数：
clubName：车友会名称
clubUrl:车友会自定义域名(域名后面一截就行)
provinceId：省ID
provinceName：省名称
cityId：城市ID
cityName：城市名称
brandId：品牌ID
brandName：品牌名称
seriesId：车系ID
seriesName：车系名称
introduce：简介
realName:姓名
gender：性别(0:男,1:女)
birthday：出生日期
clubAddressCityId：城市ID
clubAddressCityName：城市名称
clubAddressProvinceId：省ID
clubAddressProvinceName：省
postCode:邮编
address：地址
phone：联系电话
code：验证码
agree：是否同意

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

返回结果：
{code:0}

2.19修改车友会接口

接口URL:/club/editClub.do
说明:修改车友会资料

请求参数：
clubId:车友会ID
userId：用户Id，从登录信息取
editType：1》会标修改，2》宣言修改，3》公告修改
content：修改内容（url/宣言/公告）

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

返回结果：
{code:0}

2.20域名合法校验接口

接口URL:/club/checkClubUrl.do
说明:检查车友会域名是否可用

请求参数：
clubUrl：自定义域名

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

返回结果：
{code:0}

2.21车友会名合法校验接口

接口URL:/club/checkClubName.do
说明:检查车友会名称是否可用

请求参数：
name：车友会名称

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

返回结果：
{code:0}

2.22获取手机验证码接口

接口URL:http://passport2.pconline.com.cn/passport2/api/sendVerificationCode.jsp?resp_enc=utf-8
测试环境:http://test232.pchouse.com.cn:7003/passport2/api/sendVerificationCode.jsp?resp_enc=utf-8
说明:
	1.必须post提交；
	2.Http Referer = appAutoClub；
	3.同一ip一分钟之内可以发一次；
	4.同一ip一天之内只能发5次（目前的设定）；
	5.同一个手机号码一天之内只能发5次（目前的设定）；
	
	参数：
	act = getPassword
	mobile= 手机号
	(以下两个参数为必填，为了防刷而添加的，vCodeKey为通过特定的MD5加密，VCodeTime为系统当前时间)
	vCodeKey = 在出调用该接口页面前的java代码中生成
	VCodeTime = 为系统当前时间
		    //取系统当前时间再和指定key做md5加密
			String Vkey = "sendVerificationCode.jsp";
			long VCodeTime =System.currentTimeMillis();
			String vCodeKey = T.md5(Vkey + VCodeTime);
			request.setAttribute("VCodeTime", VCodeTime);
			request.setAttribute("vCodeKey", vCodeKey);
			//end匹配加密信息
	
	返回值：
	{"code":-1, "message":"...各种情况.."}
	{"code":0, "message":"发送验证码成功,手机号:1111111"}

2.23中国车友会管理条例页面

接口页面:http://www.pcauto.com.cn/forum/club/rule/

2.24车友会签到接口

接口URL:/checkIn.do
说明:用户签到车友会

请求参数：
clubId:车友会ID
agent:1
userId:用户ID，从登录信息取

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

返回结果：
{
status:0,
desc:{
continuousCheckIns:连续签到次数，
totalCheckIns:总签到次数,
petrol:签到加分值
}
}
失败返回:
{
status:非0,//-1处理错误；1没有权限/登陆；2参数错误；3不符合处理条件
desc:"错误信息"
}
被锁后签到依然作为成功返回，petrol字段返回0，app判断为0显示文案为已锁之类的

2.25编辑推荐论坛接口

测试接口URL:http://v15.pcauto.com.cn/intf/hotForums.do
正式接口URL:http://bbs.pcauto.com.cn/intf/hotForums.do
说明:获取编辑推荐

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

返回结果：
{
"data":[
{
"forumId":"论坛ID",
"lastTopicTitle":"最新标题",
"logo":"论坛logo",
"forumName":"论坛名称",
"todaypostcount":今日回复贴总数
}
]
}

2.26论坛新帖数与新帖标题接口

合并到接口:2.34

2.27论坛相关车友会接口

接口URL:/club/countClubByForumId.do
说明:根据论坛ID返回论坛相关车友会数量

请求参数：
forumId:论坛ID
userId:用户id（可选）

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

返回:
{total：车友会个数}

--------------------------------------------

接口URL:/club/listClubByForumId.do
说明:根据论坛ID返回论坛相关车友会

请求参数：
forumId:论坛ID

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

返回结果：
{
    "data": [
            {
            "logo": 车友会会标, 
            "clubStatus":车友会状态（是否被锁之类）
            "announcement":公告, 
            "memberSum": 成员数, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce":简介, 
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId": 车友会ID, 
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "regionRank": 品牌排名, 
            "rank":全国排名，
            "activitySum": 活动数, 
            "name": 车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数, 
            "activityName": 最新活动名称,
            “adminType”:成员角色//说明参考2.2
            "isCheck": true/false 是否签到
            }
	]
}

2.28同城车友会列表接口

接口URL:同2.4

2.29车友会排行榜接口

接口URL:/club/listTopClubWeekly.do
说明:top10认证人数,全国油值排行榜

请求参数：
type:0:上周新增认证人数排行,1:上周新增油值排行
userId:用户id(可选)

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

返回结果：
{
    "data": [
            {
	    "logo": 车友会会标
            "clubStatus":车友会状态
            "announcement": "内容含有敏感词，已屏蔽", 
            "memberSum": 公告, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce":简介
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId":用户ID, 
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "regionRank": 品牌排名, 
            "rank":全国排名，
            "activitySum": 活动数, 
            "name":车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数, 
            "activityName": 最新活动名称
             weekPetrol：上周新增油值（当type为1是有值）
             weekVipNum：上周新增认证人数（当type为0是有值）
            “adminType”:成员角色//说明参考2.2
            "isCheck": true/false 是否签到
            }
      ]
}

2.30 取消活动报名接口

接口URL:/activity/cancelActivity.do   
说明:取消活动报名

请求参数：
activityId:活动ID

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

返回结果：
{code:0}

2.31 获取城市列表

接口URL:http://my.pcauto.com.cn/intf/jsonArea.jsp 
说明:获取城市列表

请求参数：无
是否登录:否
缓存时间:无
是否分页:否

返回结果：
{
"areas":[
{
"citys":[
    {
    "cityName":"东城区",
    "cityCode":110101
    }],
"areaName":"北京市",
"areaCode":110000
}]
}

2.32 根据IP获取城市ID

app需要产品库对应地区，旧接口使用ip库，2.0.0版本已融合到接口2.3中，不需要额外拿地区，已废弃
接口URL:http://my.pcauto.com.cn/intf/getAreaIdByIp.jsp
说明:根据IP获取城市ID

请求参数：

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

返回结果：
{
areaName:省名称
areaCode:省编码
cityName:城市名称,
cityCode:城市编码,
ip:ip地址
}

2.33 入会审核接口

接口URL:/member/audit.do
说明:管理员对申请加入车友会的成员进行审核

请求参数：
clubId;车友会ID
action:1:通过,-1:拒绝
applicationId:申请人memberId

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

返回结果：
{
status:-1>处理错误  0>成功  1>没有权限，没有登录  2>参数错误 3>不符合处理条件
desc:信息提示
}

2.34 获取论坛最新帖子接口

测试接口URL:http://v15.pcauto.com.cn/intf/common/_block_forums_app.jsp
正式接口URL:http://bbs.pcauto.com.cn/intf/common/_block_forums_app.jsp
说明:管理员对申请加入车友会的成员进行审核

请求参数：
fids：板块ID，多个“，”分隔
callback:json 必须

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

返回结果：
{
"data":[
          {
               "count": 今天提交贴, 
               "forumId": 板块ID, 
               "forumName": "板块名称", 
               "logo": "板块图标", 
               "lastTopicAuthor": {
                   "authorId": 最后回复作者ID, 
                   "name": "最后回复作者名称", 
                   "nickname": "最后作者昵称",
                   "url": "头像"
               }, 
               "lastTopicCreateAt": "最后回复时间", 
               "lastTopicId": 最后回复ID, 
               "lastTopicTitle": "最后发表主题", 
               "lastTopicUrl": "最后发表主题链接", 
               "posts": 提交总数, 
               "todayNewtic": 今日新帖, 
               "topics": 主题帖总数, 
               "url": "板块URl"
           }
       ]
}

2.34（编号重复了，注意一下） 获取用户已参加活动列表接口

接口URL:/activity/listActivityByUserId.do
说明:根据用户ID返回该用户已经参加的活动列表

请求参数：
userId:用户ID

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

返回结果:
{
    "userId": 用户ID,
    "pageNo": 当前页数, 
    "pageSize": 分页代销, 
　 "clubName": "车友会名称",
　 "total": 活动总数, 
    "data": [
        {
            "clubId": 车友会ID,
            "clubName": "车友会名称",
	    "activityId": 活动ID, 
            "title": "活动标题",
            "signupDate": "报名截止时间", 
            "pic": "活动封面图", 
            "place": "活动地址", 
            "endDate": "活动结束时间", 
            "beginDate": "活动开始时间"
            "statusMsg":活动状态
            "statusCode":活动状态码//参考2.10
        }
    ]
}

2.35 图片上传接口

接口URL:http://upc.pcauto.com.cn/upload_quick.jsp
说明:通用图片上传接口,包括车友会会标,留言,论坛等

请求参数：
application:yidong

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

成功返回:
{
retCode: 0,
tid:xxx,
files:[
{rid:xxx, fileName:xxx, url:xxx, orgFileName:xxx, width, height}
]
}
失败返回：{retCode: xxx}
留言增加居中正方形截图指令53013

v2.1.0新增

2.36 ip获取地区接口

url:http://my.pcauto.com.cn/intf/getAreaIdByIp.jsp 
无请求参数，后台根据请求链接获取ip
返回
{
areaCode:省id
areaName:省名字
cityCode:城市ID//如无城市，则id为0
cityName:城市名字//无则为空字符串
ip:ip地址
}

2.37 活动审核列表

url:/activity/listActivityAudit.do
是否分页:否
是否登陆:是
是否缓存:否
请求参数:
activityId:活动id
common_session_id
返回
{
data:[
userId:用户id
nickname:昵称
memberId：申请人ID
name；真实姓名
phone：联系电话
joinNum：参加人数
lincensePlate；车牌号
descript：备注信息]
}

2.38 活动审核操作（通过、拒绝）

url:/activity/auditActivity.do
是否登录:是
是否分页:否
是否缓存:否
请求参数：
activityId;车友会ID
action:1:通过,-1:拒绝
targetId:申请人memberId
返回结果：
{
code://增加1004为人数上限，需要app写文案
message:
}

2.39 发现首页活动焦点图(CMS)

url:http://www.pcauto.com.cn/forum/club/activeapp/
是否分页:无
是否缓存:无
是否登陆:无
请求参数:无
返回
{
activelist:[
	“img”:图片url,
	“title”:标题,
	“url”:”http://bbs.pcauto.com.cn/topic-123.html //只含帖子与专题两种，专题用PC端接口，判断http://bbs.pcauto.com.cn/topic- 为帖子，其他弹全屏webview，需求方确认结果
]
}

编辑录入可配置title url，默认于网站一致

2.40 热门活动日记

url:/activity/listHostActivityDiary.do
是否登陆:否
是否分页:否
是否缓存:是
请求参数:
size:接口返回多少条数据（最大不能超过50）
返回：
返回结果：
{
    "data": [
             {
	    “clubName”:车友会名字
            “clubId”:车友会id
            "title": 帖子标题, 
            "image1": 第一张图,  
            "image2": 第二张图, 
            "image3": 第三张图,  //小于等于3张
            "topicId": 帖子ID,
      	    "pubTime": 自定义时间,
            "nickname":昵称
            "userId":
           }
	]
}

2.41 获取车友会操作权限(报名 创建)

url:/club/getOperateAuthority.do
请求参数
userId:用户id 
clubId:车友会id//判断能否创建传clubId为0

返回
{
“clubId”:车友会Id
“adminType”:成员角色//说明参考2.2
“message”:无法申请加入车友会原因文案
}

2.42 判断能否申请加入活动(只有申请加入活动才调用)

url:/activity/isJoinActivity.do
是否登录:是
是否分页:否
是否缓存:否
请求参数：
activityId;活动ID
targetId:申请人memberId
返回结果：
{
        “statusMsg”:状态名字，服务器返回显示火热报名，已报名等状态的文字，app建议直接读取这个新的字段显示
        "statusCode":状态码//参考2.10
}

2.43 推送设置接口

    url:/interface/club/do_autoClubUserApp.jsp
    参数：
     userId://用户id，登出则不传本参数
     token：//设备token
     ids:  //1,0,1 字符串，顺序表示帖子回复，私信，系统通知，1为打开，0为关闭
     beginTime:（如果勿扰模式关闭了，就不传此字段）02:00传02 23:00传23
     endTime:（如果勿扰模式关闭了，就不传此字段）02:00传02 23:00传23
     open: （1发推送，0不发推送）
     sound：（1为有声音，0为无）
     shake：（1为有振动，0为无）
    请求方法：post
    是否需要登录：是
    返回参数：
    {
      "description":"token或者ids为空",//错误详情
      "status":0;   （0：成功
                          -1：ids不正确或者日期格式不正确  
                          -2：token为空或者ids为空
                          -3：提交方式不对，请改用Post提交
                          -4：设置失败）
    }

3.1 IM获取token

请求url:/club/getToken.do,
请求方式:POST,
是否需要登录:是,
返缓存方式:无,
缓存时间:无,
请求参数:
userId://太平洋帐号id,
grabber: //是否需要强制获取新的Token，0：不需要，1：需要
返回结果:
{
           "token":"P0JtJ0LBGI9Qya1+uIPR0dLyEN9NFQAM0jQTPx8aQUQg5RfoaakM54il9pxVp1TGrpEVXynHbxxfokmJy1QkcQ==",
           "code":0,
           "msg":"成功获取token！"
}
token 获取融云Token
message 返回结果描述
code 返回结果代码，1：非登录用户，2：不是车友会成员，3：获取Token导演，0：操作成功

3.2 IM获取好友列表

    请求url:/club/getFriendList.do,
    HTTP请求方式:POST,
    是否需要登录:true,
    返回格式:json,
    返缓存方式:无,
    缓存时间:无,
    请求参数:clubId://车友会id,,
    说明:
    返回结果:
{
code:0 //code 返回结果代码，1：车友会没有通过审核，0：操作成功
message://返回结果描述
friendList:[
     {
         userId://太平洋帐号id
         userName://昵称
         faceUrl://头像url
      }
     ],
image:http://xxxxx 群组头像
}

4.1车友动态接口

接口URL:/dyna/getDynaList.do
说明:根据车友会ID,返回车友动态列表
请求参数：
clubId:车友会ID（二选一）
userId:用户Id（二选一）
type:筛选 1帖子(不全，只返回车友会对应用户帖子)，2动态 , 默认0全部
是否登录:否
缓存时间:无
是否分页:是

返回结果：
{
    "clubId": clubId, （二选一）
    "userId": userId, （二选一）
    "data": [
             {
             "postCount":回复数
	     "pubTime": 发布时间, 
            "topicTitle": 帖子标题, 
            "forumName": 板块名称, 
            "isPick": 是否是精华, 
	    "isPost": 是否帖子, 
            "authorId": 作者ID, 
            "forumId": 16160, 
            "authorName": 作者名称, 
            "nickname":作者昵称,
            "contribution": 贡献油值, 
            "topicId": 帖子ID,
            "dynaInfoId",动态ID
            "authorPhoto": 作者头像, 
            "isRecommend": 是否是推荐,
            “content”:动态内容
            "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
		}
	        ]
           }
	]
}

4.2 发动态

    请求url:/dyna/createCommentDyna.do,
    HTTP请求方式:POST,
    是否需要登录:true,
    返回格式:json,
    返缓存方式:无,
    缓存时间:无,
    请求参数:
        clubId 车友会ID
        content 留言内容
        images:[
               {
                    url:"http://xxxxx",
                    width:100 //宽
                    height:200 //高
               },
               {
                    url:"http://xxxxx",
                    width:100 //宽
                    height:200 //高
               }
         ]//图片
    说明:
    图片上传指令 command:53003 53004 53016 53017 53018 53019 53020
    返回结果:{
	code:0			//错误代码,0:正常返回 1:操作失败 1001:权限类错误 1002:数据类错误 1003:用户无登陆
	message: “您还没有登陆”		//错误提示
}

4.3修改个人信息

    请求url:http://my.pcauto.com.cn/intf/updateUser.jsp,
    HTTP请求方式:POST,
    是否需要登录:true,
    返回格式:json,
    返缓存方式:无,
    缓存时间:无,
    请求参数:
       domicileId;城市ID
       nickName：昵称
       telephone;电话号码
       realName;真实姓名
       address;地址
       msn;msn账号
       qq;qq账号
       zip;邮编
       birthday;出生日期 //格式YYYY-MM-DD
       gender   1>男  2女  0 未知
    返回结果:{
	code:0			//错误代码,0:正常返回
	message: “您还没有登陆”		//错误提示
}

4.4 回复动态

    请求URL：/dyna/replyDyna.do
    HTTP请求方式:POST,
    是否需要登录:true,
    返回格式:json,
    返缓存方式:无,
    缓存时间:无
    请求参数:
       clubId 车友会ID
       content 留言内容
       dynaInfoId 动态ID
       postToDynaReplyId 发表回复的回复ID
       createDate 创建时间，列表数据的pubTime，后台查表需要，格式yyyy-MM-dd
    返回结果：
{
         code	返回结果代码,正常返回 1:操作失败 1001:权限类错误 1002:数据类错误 1003:用户无登陆  
         message	返回结果描述
         data:{
                    replyId://回复id
                    userId://用户ID
                    authorPhoto://用户头像
                    nickname://用户昵称
                    content://回复内容
                    createDate://回复时间
                    postToDynaReplyId://被回复id(为回复回复时返回)
                    postToUserId://被回复用户ID(为回复回复时返回)
                    postToNickName://被回复用户昵称(为回复回复时返回)
              }
}

4.5 动态回复列表

    请求URL：
    HTTP请求方式:GET,
    是否需要登录:false,
    返回格式:json,
    返缓存方式:无,
    缓存时间:无,
    是否分页:是
    请求参数:
        dynaInfoId 动态ID
        createDate 创建时间，列表数据的pubTime，后台查表需要
    返回结果:
 {
       dynaInfoId://动态ID
       replys:[
              {
                    replyId://回复id
                    userId://用户ID
                    authorPhoto://用户头像
                    userName://用户昵称
                    content://回复内容
                    replyToId://被回复id(为回复回复时返回)
                    replyToUserId://被回复用户ID(为回复回复时返回)
                    replyToUserName://被回复用户昵称(为回复回复时返回)
              }
       ]
}

4.6个人中心帖子列表

接口URL:
bbs.pcauto.com.cn/plugins/autoclub/user/topics.do
说明:根据用户id返回所有帖子列表
是否分页:是
请求参数：
userId: 用户ID
imgSize: 需要图片数，默认为3张
audited: 是否审核通过，默认为true
maxLength: 帖子内容长度，默认为240
resp_enc: 编码，默认为UTF-8
返回
与4.1一致

Attachments