Changes between Version 129 and Version 130 of pcauto_club_2.0.0/api


Ignore:
Timestamp:
11/11/2014 10:43:50 AM (11 years ago)
Author:
xieweijie
Comment:

更新3.0.0接口文档

Legend:

Unmodified
Added
Removed
Modified

  • pcauto_club_2.0.0/api

    v129 v130  
    220220provinceId:省id 
    221221cityId:城市ID（无则无须传cityid） 
    222 brandId:品牌id 
     222brand:品牌id 
    223223seriesId:车系ID 
    224224clubName:车友会名称 
    … …  
    392392albumId:相册ID 
    393393userId:用户id，从登录信息取 
    394 urls : 格式:名称@路径，多张图片以”,”分割(上传原图url) 
     394urls : 格式:名称@路径@尺寸，多张图片以”,”分割(上传原图url) 
     395如 abc@http://123.png@100x150 
    395396 
    396397是否登录:是 
    … …  
    739740code：验证码 
    740741agree：是否同意 
     742type:车友会类型 1-》地区 2-》车系 3-》主题 
     743themeId:主题类型id，看主题列表接口返回的id 
     744appBanner:车友会背景URL 
    741745 
    742746是否登录:是 
    … …  
    963967返回结果： 
    964968{ 
    965     “countryRank”：全国排名 
    966     “contryRankAsc”:全国排名上升多少，下降则为负数 
    967     “seriesRank”：车系排名 
    968     “seriesRankAsc”:车系排名上升多少，下降则为负数 
    969     “regionRank”：地区排名 
    970     “regionRankAsc”:地区排名上升多少，下降则为负数 
     969    “rank”：全国排名 
     970    “rankAsc”:全国排名上升多少，下降则为负数 
     971    “brandRank”：车系排名 
     972    “brandRankAsc”:车系排名上升多少，下降则为负数 
     973    “provinceRank”：地区排名 
     974    “provinceRankAsc”:地区排名上升多少，下降则为负数 
    971975    以上信息假设user对应无加入车友会则不返回 
    972976    "data": [ 
    … …  
    13921396                “id”:背景id 
    13931397                “title”:背景文字 
    1394                 “img”:背景图片url 
     1398                “img”:背景图片url，提交保存用 
     1399                "thumbImg":列表显示图 
    13951400           }, 
    13961401           { 
    13971402                “id”:背景id 
    13981403                “title”:背景文字 
    1399                 “img”:背景图片url 
     1404                “img”:背景图片url，提交保存用 
     1405                "thumbImg":列表显示图 
    14001406           } 
    14011407    ] 
    14021408}}} 
    1403 === 2.45主题列表 === 
     1409 
     1410=== 2.45获取最新消息数 === 
     1411{{{ 
     1412接口：http://mrobot.pcauto.com.cn/v3/bbs/getNewMsgCount 
     1413说明：获取最新未读数 
     1414返回： 
     1415{ 
     1416    ACNewMsgSender:0 未读收到回复动态用户名 
     1417    articleCmtCount:0  
     1418    autoClubDynaCount:0 未读新发动态（暂无作用，动态未读请用autoClubNewsfeedCount） 
     1419    autoClubNewMsg:0 未读收到动态内容; 
     1420    autoClubNewTime:1414489274000; 
     1421    autoClubNewsfeedCount:5 未读收到回复动态; 
     1422    autoClubTaskCount:0 ; 
     1423    carReplyCount:0; 
     1424    commentReplyCount:0; 
     1425    fansCount:29; 
     1426    forumReplyCount:0 未读收到帖子回复数; 
     1427    forumReplyNewMsg: 未读收到帖子回复内容; 
     1428    forumReplyNewTime:1411910575000  未读收到帖子回复时间; 
     1429    forumReplySender:xiechuyu  未读收到帖子回复作者; 
     1430    forumReplySenderID:32010420  未读收到帖子回复作者id; 
     1431    messageCount:0  未读收到私信数; 
     1432    messageNewMsg:T2 未读收到私信内容; 
     1433    messageNewTime:1411624464000 未读收到私信时间; 
     1434    messageSender:bjbjbjbj822800 未读收到私信人; 
     1435    messageSenderID:4387176 未读收到私信人ID; 
     1436    systemNoticeCount:0 未读系统消息数; 
     1437    systemNoticeNewMsg: 未读系统消息内容 
     1438    systemNoticeNewTime:1413525025000 未读系统消息时间; 
     1439} 
     1440}}} 
     1441 
     1442=== 2.46主题列表 === 
    14041443{{{ 
    14051444接口：/club/listAllTheme.do 
    … …  
    16681707=== 4.7收到的回复（帖子、动态） === 
    16691708{{{ 
     1709接口：http://mrobot.pcauto.com.cn/club/bbs/getClubReplyReminds 
    16701710说明：收到的回复（帖子、动态） 
    16711711 
    … …  
    16801720"data": [ 
    16811721             { 
    1682         “replyType”：类型，0帖子 1动态 
     1722        “replyType”：类型，1帖子 2动态 
    16831723        “targetId”:点击进入详情用的id 
    16841724        “replyId”:回复id, 
    … …  
    16921732          }， 
    16931733        { 
    1694         “replyType”：类型，0帖子 1动态 
     1734        “replyType”：类型，1帖子 2动态 
    16951735        “targetId”:点击进入详情用的id 
    16961736        “replyId”:回复id, 
    … …  
    17051745    ] 
    17061746帖子回复和动态回复要求对应返回字段一致 
     1747}}} 
     1748=== 4.8获取动态 === 
     1749{{{ 
     1750接口：/dyna/getDynaDetail.do 
     1751说明：根据动态id获取动态信息 
     1752请求参数： 
     1753dynaInfoId：动态id 
     1754createDate：动态创建时间，yyyy-mm-dd格式 
     1755返回 
     1756data： 
     1757{ 
     1758             "postCount":回复数 
     1759             "pubTime": 发布时间,  
     1760            "authorId": 作者ID,  
     1761            "forumId": 16160,  
     1762            "authorName": 作者名称,  
     1763            "nickname":作者昵称, 
     1764            "contribution": 贡献油值,  
     1765            "dynaInfoId",动态ID 
     1766            "authorPhoto": 作者头像,  
     1767            "isRecommend": 是否是推荐, 
     1768            “content”:动态内容 
     1769            "images":[ 
     1770                { 
     1771                        “url”:http://xxxx.jpg, 
     1772                        //真实宽度 
     1773                        “width”:960, 
     1774                        //真实高度 
     1775                        “height”:1000, 
     1776                        //质量参数,默认为0，10月上线 
     1777                        "qua":80 
     1778                }, 
     1779                { 
     1780                        “url”:http://xxxx.jpg, 
     1781                        //真实宽度 
     1782                        “width”:960, 
     1783                        //真实高度 
     1784                        “height”:1000, 
     1785                        //质量参数,默认为0，10月上线 
     1786                        "qua":80 
     1787                } 
     1788                ] 
     1789} 
    17071790}}} 
    17081791=== 5.1兑换列表 === 
    … …  
    17341817    ] 
    17351818}}} 
     1819 
    17361820=== 5.2用户兑换信息 === 
    17371821{{{ 
    … …  
    17551839    } 
    17561840}}} 
     1841 
    17571842=== 5.3申请兑换 === 
    17581843{{{ 
    … …  
    17781863返回 
    17791864}}} 
     1865 
    17801866=== 5.4兑换记录 === 
    17811867{{{ 
    … …  
    18141900接口：/user/listUserByPosition.do 
    18151901说明：附近的人列表 
    1816  
    18171902请求参数 
    18181903longitude 经度 
    18191904latitude 纬度 
     1905userId 当前用户id，用于返回结果去掉 
    18201906 
    18211907是否登录:否 
    … …  
    18271913             { 
    18281914                “userId”:用户id 
    1829                 “userName”:用户昵称 
     1915                “nickName”:用户昵称 
    18301916                “userImg”:用户头像 
    18311917                “sex”：性别 
    1832                 “distance”：距离 
     1918                “distance”：距离，//直接显示 
    18331919                “serialName”：认证车系 
    18341920          }， 
    … …  
    18381924                “userImg”:用户头像 
    18391925                “sex”：性别 
    1840                 “distance”：距离 
     1926                “distance”：距离//直接显示 
    18411927                “serialName”：认证车系 
    18421928          }， 
    18431929    ] 
    18441930}}} 
     1931 
    18451932=== 6.2更新用户位置信息 === 
    18461933{{{ 
    18471934说明：更新用户所在位置 
    1848  
     1935接口：/user/updateUserPosition 
    18491936请求方法:POST 
    18501937请求参数 
    18511938longitude 经度 
    18521939latitude 纬度 
    1853 session拿userid信息 
    1854 }}} 
     1940}}} 
     1941 
    18551942=== 7.1 任务列表 === 
    18561943{{{ 
     1944PS:开发环境域名http://dev38.pcauto.com.cn:8085 
     1945域名：task.pcauto.com.cn 
     1946说明：获取用户任务列表 
     1947接口:/intf/clubgc/app/taskList.do 
    18571948请求参数 
    1858 session拿用户参数 
    1859  
    18601949是否登录:是 
    18611950缓存时间:无 
    … …  
    18641953返回 
    18651954{ 
    1866 “disposableMission”:[ 
    1867 { 
    1868         “missionId”：任务id，或任务类型，每个任务一个 
    1869         “missionName”:”任务名称” 
    1870         “missionIcon”：任务icon 
     1955“disposableTask“:[ 
     1956{ 
     1957        “taskId”：任务id，或任务类型，每个任务一个 
     1958        “taskName”:”任务名称” 
     1959        “applogo”：任务icon 
    18711960        “gold”：“加金币数” 
    1872         “limitCount”：上限数//无则返回0 
    1873         “currentCount”：当前数//无则返回0，例如发了多少帖子 
    1874         “status”：有无领取奖励的状态, 
    1875         “dis”:描述 
    1876         “action”:点击触发,如app内跳转pcautoclub://XXX或直接网址http://xxxx，参考焦点图action处理方式 
     1961        “limitPermanantly”：上限数//无则返回0，注意这个字段和下面的不一样 
     1962        “current”：当前数//无则返回0，例如发了多少帖子 
     1963        “status”：完成的状态, status=0表示未完成 =1表示已完成 
     1964        "received"：是否领取，0未领取，1已领取 
     1965        “appAction”:{ 
     1966               “action”:点击触发,如app内跳转pcautoclub://XXX或直接网址http://xxxx，参考焦点图action处理方式 
     1967               “desc”:描述 
     1968        } 
    18771969}//一次性任务 
    1878 “commonMission”:[ 
    1879 { 
    1880         “missionId”：任务id，或任务类型，每个任务一个 
    1881         “missionName”:”任务名称” 
    1882         “missionIcon”：任务icon 
     1970“normalTasks”:[ 
     1971{ 
     1972        “taskId”：任务id，或任务类型，每个任务一个 
     1973        “taskName”:”任务名称” 
     1974        “applogo”：任务icon 
    18831975        “gold”：“加金币数” 
    1884         “limitCount”：上限数//无则返回0 
    1885         “currentCount”：当前数//无则返回0，例如发了多少帖子 
    1886         “status”：有无领取奖励的状态 
    1887         “dis”:描述 
    1888         “action”:点击触发,如app内跳转pcautoclub://XXX或直接网址http://xxxx，参考焦点图action处理方式 
     1976        “limitDaily”：上限数//无则返回0 
     1977        “current”：当前数//无则返回0，例如发了多少帖子 
     1978        “status”：完成的状态, status=0表示未完成 =1表示已完成 
     1979        "received"：是否领取，0未领取，1已领取 
     1980        “appAction”:{ 
     1981               “action”:点击触发,如app内跳转pcautoclub://XXX或直接网址http://xxxx，参考焦点图action处理方式 
     1982               “desc”:描述 
     1983        } 
    18891984}//普通任务 
    18901985] 
    … …  
    18941989=== 7.2领取奖励 === 
    18951990{{{ 
     1991PS:开发环境域名http://dev38.pcauto.com.cn:8085 
     1992域名：task.pcauto.com.cn 
    18961993说明：点击领取奖励 
    1897  
     1994接口：/intf/clubgc/recieveGoldCoin.do 
    18981995请求方法：POST 
    18991996请求参数 
    1900 任务missionId 
    1901 session获取用户信息 
    1902  
     1997taskId：任务id 
    19031998返回 
     1999 
     2000任务id后台相关：http://rdtrac.pc.com.cn/autoclub/wiki/taskdef 
    19042001}}} 
    19052002=== 8.1 同城优惠列表 === 
    19062003{{{ 
    19072004说明：获取同城优惠列表 
    1908  
     2005接口：/club/listLocalPromotion.do 
    19092006请求参数 
    19102007provinceId 发动态省地区id（必选） 
    … …  
    19192016data:[ 
    19202017        { 
    1921         “topicId”：帖子id 
     2018        “topicUrl”:http://bbs.pcauto.com.cn/topic-5460623.html 帖子url 
    19222019        “img”:帖子图片 
    19232020        “startTime”优惠开始时间 
    … …  
    19262023        }， 
    19272024        { 
    1928         “topicId”：帖子id 
     2025        “topicUrl”:http://bbs.pcauto.com.cn/topic-5460623.html 帖子url 
    19292026        “img”:帖子图片 
    19302027        “startTime”优惠开始时间 
    … …  
    19392036{{{ 
    19402037说明：同城首页信息，包括同城车友会（<3个），同城优惠（<5个） 
     2038接口：/club/listLocalClubAndPromotions.do 
    19412039请求参数 
    19422040provinceId 发动态省地区id（必选） 
    … …  
    19882086“preferentialData”:[ 
    19892087        { 
    1990         “topicId”：帖子id 
    1991         “img”:帖子图片 
    1992         “time”帖子创建时间 
    1993         “title”：帖子标题 
     2088        endTime = 1415030400000; 
     2089        img:图片 
     2090        startTime = 1412092800000; 
     2091        time:时间 
     2092        title:标题 
     2093        topicUrl：http://bbs.pcauto.com.cn/topic-5460623.html 帖子url 
    19942094} 
    19952095]//前5条 
    … …  
    20522152接口：/util/userQrCode.jsp 
    20532153我的二维码（参考车友会二维码） 
     2154请求参数: 
     2155userId 
    20542156扫描结果 
    20552157http://用户主页?action=pcautoclub://user-center/用户id 
    … …  
    21422244{{{ 
    21432245任务： 
    2144 手机绑定帐号 
    2145 申请成为认证车主 
    2146 有一个帖子被设置为精华帖 
    2147 发表1个主题帖 
     2246手机绑定帐号（取消该功能） 
     2247申请成为认证车主 http://m.pcauto.com.cn/bbs/3g/toApply.do?fromPcautoApp 
     2248有一个帖子被设置为精华帖 http://m.pcauto.com.cn/bbs/topic-5092954.html 
     2249发表1个主题帖 http://m.pcauto.com.cn/bbs/topic-5092954.html 
    21482250 
    21492251其他： 
    2150 常见问题（创建车友会） 
    2151 升级车友会 
    2152 }}} 
    2153  
    2154 === 2.8上传图片接口 === 
    2155 {{{ 
    2156 接口URL:/album/uploadPic.do 
    2157 说明:上传图片到车友会指定相册 
    2158  
    2159 请求参数： 
    2160 albumId:相册ID 
    2161 userId:用户id，从登录信息取 
    2162 urls : 格式:名称@路径@尺寸，多张图片以”,”分割(上传原图url) 
    2163 如 abc@http://123.png@100x150 
    2164  
    2165 是否登录:是 
    2166 缓存时间:无 
    2167 是否分页:否 
    2168  
    2169 返回结果： 
    2170 {code:0} 
    2171 }}} 
     2252常见问题（创建车友会）http://www1.pcauto.com.cn/app/autoclub/QA.html 
     2253升级车友会 http://club.pcauto.com.cn/wap/club/levelPrizes.do?clubId= 
     2254}}}