wiki:appapi/3.0

Version 3 (modified by zhouruxuan, 11 years ago) (diff)

--

接口索引

    1. 1. 车友会提供APP接口
      1. 1.1 车友会相关
        1. 1.1.1 创建品牌车友会接口
        2. 1.1.2 创建地区车友会接口
        3. 1.1.3 创建主题车友会接口
        4. 1.1.4 修改车友会接口
        5. 1.1.5 车友会搜索接口
        6. 1.1.6 转让会长接口
        7. 1.1.7 设置副会长接口
        8. 1.1.8 解除职务接口
        9. 1.1.10 退出车友会接口（被会长进行移出车友会）
        10. 1.1.11 退出车友会接口(用户自己进行退出））
        11. 1.1.12 取消审核中车友会申请
        12. 1.1.13 车友会排行（上周新增认证人数排行）
        13. 1.1.14 车友会排行（上周新增油值排行）
        14. 1.1.15 车友会排行（全国排名）
        15. 1.1.16 车友会排行（品牌排名）
        16. 1.1.17 车友会排行（地区排名）
        17. 1.1.18 同城首页信息（同城车友会）
        18. 1.1.19 同城首页信息（同城优惠）

1. 车友会提供APP接口

1.1 车友会相关

1.1.1 创建品牌车友会接口

接口/appapi/club/createClubByBrand.do [POST]
说明:创建品牌车友会接口
请求参数：
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：联系电话
qqGroup:Q群号
code：验证码
agree：是否同意
themeId:主题类型id，看主题列表接口返回的id
appBanner:车友会背景URL

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

返回结果：
{code:0}

1.1.2 创建地区车友会接口

接口/appapi/club/createClubByArea.do [POST]
说明:创建地区车友会接口
请求参数：
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：联系电话
qqGroup:Q群号
code：验证码
agree：是否同意
themeId:主题类型id，看主题列表接口返回的id
appBanner:车友会背景URL

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

返回结果：
{code:0}

1.1.3 创建主题车友会接口

接口/appapi/club/createClubByTheme.do [POST]
说明:创建主题车友会接口
请求参数：
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：联系电话
qqGroup:Q群号
code：验证码
agree：是否同意
themeId:主题类型id，看主题列表接口返回的id
appBanner:车友会背景URL

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

返回结果：
{code:0}

1.1.4 修改车友会接口

接口/appapi/club/editClub.do [POST]
说明:修改车友会接口
请求参数：
logo：会标
introduce：车友会简介
notice：车友会通知
appBanner：车友会主题URL

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

返回结果：
{code:0}

1.1.5 车友会搜索接口

接口URL:/appapi/club/getClubByCityOrRegionId.do[GET]
说明:搜索,精确查找,根据id查找，根据主题查找

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

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

返回结果：
"data": [
             {
            "logo": 车友会会标
	“clubBackgroundImg”://顶部背景图片url
	“levelupTip”:升级提示，0-》不可升级，1-》可升级
	“applyCount”：待审核人数，
	“presidentName”：会长昵称
            "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，用于发帖
           }
    ]

1.1.6 转让会长接口

接口URL:/appapi/member/transferClubAdmin.do [POST]
说明:转让会长接口

请求参数：
clubId：车友会ID
targetId：操作用户memberId


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

返回结果：
{code:0}

1.1.7 设置副会长接口

接口URL:/appapi/member/setClubViceAdmin.do [POST]
说明:设置副会长接口

请求参数：
clubId：车友会ID
targetId：操作用户memberId


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

返回结果：
{code:0}

1.1.8 解除职务接口

接口URL:/appapi/member/removalClubOffice.do [POST]
说明:解除职务接口

请求参数：
clubId：车友会ID
targetId：操作用户memberId


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

返回结果：
{code:0}

1.1.10 退出车友会接口（被会长进行移出车友会）

接口URL:/appapi/member/removeClub.do [POST]
说明:移除车友会接口（被会长进行移出车友会）

请求参数：
clubId：车友会ID
targetId：操作用户memberId


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

返回结果：
{code:0}

1.1.11 退出车友会接口(用户自己进行退出））

接口URL:/appapi/member/quitClub.do [POST]
说明:退出车友会接口(用户自己进行退出））

请求参数：
clubId：车友会ID
targetId：操作用户memberId


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

返回结果：
{code:0}

1.1.12 取消审核中车友会申请

接口URL:/appapi/member/cancleApplyRecord.do [POST]
说明:取消审核中车友会申请

请求参数：
clubId：车友会ID
targetId：操作用户memberId


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

返回结果：
{code:0}

1.1.13 车友会排行（上周新增认证人数排行）

接口URL:/appapi/club/listTopClubWeeklyByAuth.do [POST]
说明:车友会排行（上周新增认证人数排行）

请求参数：
userId：车友会ID

是否登录:否
缓存时间:是（30分钟）
是否分页:否

返回结果：
{
    “rank”：全国排名
    “rankAsc”:全国排名上升多少，下降则为负数
    “brandRank”：车系排名
    “brandRankAsc”:车系排名上升多少，下降则为负数
    “provinceRank”：地区排名
    “provinceRankAsc”:地区排名上升多少，下降则为负数
    以上信息假设user对应无加入车友会则不返回
    "data": [
            {
	"logo": 车友会会标
	“clubBackgroundImg”://顶部背景图片url
	“levelupTip”:升级提示，0-》不可升级，1-》可升级
	“applyCount”：待审核人数，
	“presidentName”：会长昵称
            "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 是否签到
            }
      ]
//前20
 "clubIndexData": [
            {
	    "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 是否签到
            }
      ]
//user所加入车友会前后两个，自己，后面两个
}

1.1.14 车友会排行（上周新增油值排行）

接口URL:/appapi/club/listTopClubWeeklyByPetrol.do [POST]
说明:车友会排行（上周新增油值排行）

请求参数：
userId：车友会ID

是否登录:否
缓存时间:是（30分钟）
是否分页:否

返回结果：
{
    “rank”：全国排名
    “rankAsc”:全国排名上升多少，下降则为负数
    “brandRank”：车系排名
    “brandRankAsc”:车系排名上升多少，下降则为负数
    “provinceRank”：地区排名
    “provinceRankAsc”:地区排名上升多少，下降则为负数
    以上信息假设user对应无加入车友会则不返回
    "data": [
            {
	"logo": 车友会会标
	“clubBackgroundImg”://顶部背景图片url
	“levelupTip”:升级提示，0-》不可升级，1-》可升级
	“applyCount”：待审核人数，
	“presidentName”：会长昵称
            "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 是否签到
            }
      ]
//前20
 "clubIndexData": [
            {
	    "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 是否签到
            }
      ]
//user所加入车友会前后两个，自己，后面两个
}

1.1.15 车友会排行（全国排名）

接口URL:/appapi/club/listTopClubWeeklyByNationwide.do [POST]
说明:车友会排行（全国排名）

请求参数：
userId：车友会ID

是否登录:否
缓存时间:是（30分钟）
是否分页:否

返回结果：
{
    “rank”：全国排名
    “rankAsc”:全国排名上升多少，下降则为负数
    “brandRank”：车系排名
    “brandRankAsc”:车系排名上升多少，下降则为负数
    “provinceRank”：地区排名
    “provinceRankAsc”:地区排名上升多少，下降则为负数
    以上信息假设user对应无加入车友会则不返回
    "data": [
            {
	"logo": 车友会会标
	“clubBackgroundImg”://顶部背景图片url
	“levelupTip”:升级提示，0-》不可升级，1-》可升级
	“applyCount”：待审核人数，
	“presidentName”：会长昵称
            "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 是否签到
            }
      ]
//前20
 "clubIndexData": [
            {
	    "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 是否签到
            }
      ]
//user所加入车友会前后两个，自己，后面两个
}

1.1.16 车友会排行（品牌排名）

接口URL:/appapi/club/listTopClubWeeklyByBrand.do [POST]
说明:车友会排行（品牌排名）

请求参数：
userId：车友会ID

是否登录:否
缓存时间:是（30分钟）
是否分页:否

返回结果：
{
    “rank”：全国排名
    “rankAsc”:全国排名上升多少，下降则为负数
    “brandRank”：车系排名
    “brandRankAsc”:车系排名上升多少，下降则为负数
    “provinceRank”：地区排名
    “provinceRankAsc”:地区排名上升多少，下降则为负数
    以上信息假设user对应无加入车友会则不返回
    "data": [
            {
	"logo": 车友会会标
	“clubBackgroundImg”://顶部背景图片url
	“levelupTip”:升级提示，0-》不可升级，1-》可升级
	“applyCount”：待审核人数，
	“presidentName”：会长昵称
            "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 是否签到
            }
      ]
//前20
 "clubIndexData": [
            {
	    "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 是否签到
            }
      ]
//user所加入车友会前后两个，自己，后面两个
}

1.1.17 车友会排行（地区排名）

接口URL:/appapi/club/listTopClubWeeklyByArea.do [POST]
说明:车友会排行（地区排名）

请求参数：
userId：车友会ID

是否登录:否
缓存时间:是（30分钟）
是否分页:否

返回结果：
{
    “rank”：全国排名
    “rankAsc”:全国排名上升多少，下降则为负数
    “brandRank”：车系排名
    “brandRankAsc”:车系排名上升多少，下降则为负数
    “provinceRank”：地区排名
    “provinceRankAsc”:地区排名上升多少，下降则为负数
    以上信息假设user对应无加入车友会则不返回
    "data": [
            {
	"logo": 车友会会标
	“clubBackgroundImg”://顶部背景图片url
	“levelupTip”:升级提示，0-》不可升级，1-》可升级
	“applyCount”：待审核人数，
	“presidentName”：会长昵称
            "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 是否签到
            }
      ]
//前20
 "clubIndexData": [
            {
	    "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 是否签到
            }
      ]
//user所加入车友会前后两个，自己，后面两个
}

1.1.18 同城首页信息（同城车友会）

说明：同城首页信息（同城车友会）（<3个）
接口：/appapi/club/listTongChengClubs.do [GET]
请求参数
provinceId 发动态省地区id（必选）
cityId 发动态市地区id（无则不传）

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

返回
{
“sameCityClubCount”:同城车友会总数
“sameCityClubData”:[
	{
            "logo": 车友会会标
	    “clubBackgroundImg”://顶部背景图片url
	    “levelupTip”:升级提示，0-》不可升级，1-》可升级
	    “applyCount”：待审核人数，
	    “presidentName”：会长昵称
            "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，用于发帖
           }
]//前三个
}

1.1.19 同城首页信息（同城优惠）

说明：同城首页信息（同城优惠）（<5个）
接口：/appapi/club/listTongChengYouhui.do [GET]
请求参数
provinceId 发动态省地区id（必选）
cityId 发动态市地区id（无则不传）

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

返回
{
“sameCityPreferentialCount”:同城优惠总数
“preferentialData”:[
	{
	endTime = 1415030400000;
        img:图片
        startTime = 1412092800000;
        time:时间
        title:标题
        topicUrl：http://bbs.pcauto.com.cn/topic-5460623.html 帖子url
}
]//前5条
}
返回
顶部