Changes between Version 22 and Version 23 of pcauto_club_4.2.0/api


Ignore:
Timestamp:
05/25/2015 01:59:31 PM (11 years ago)
Author:
liangzhicong
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • pcauto_club_4.2.0/api

    v22 v23  
    1616}}} 
    1717 
    18 === 1.1 车友会相关接口 
    19  
    20 ==== 1.1.1 绑定车友圈 ==== 
    21  
    22 {{{ 
    23 接口/appapi/1.0/forum/bundUserForum.do [POST] 
    24 说明 : 绑定车友圈 
    25 请求参数 ： 
    26   forumId:版块ID 
    27   forumName:版块名字 
    28  
    29  
    30 是否登录 : 是 
    31 缓存时间 : 无 
    32 是否分页 : 否 
    33  
    34  
    35 返回结果： 
    36 { 
    37    code : 0成功，-1失败 
    38    message : 提示信息 
    39    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    40 } 
    41 }}} 
    42  
    43 ==== 1.1.2 解绑车友圈 ==== 
    44 {{{ 
    45 接口/appapi/1.0/forum/unBundUserForum.do [POST] 
    46 说明 : 解绑车友圈 
    47 请求参数 ： 
    48   forumId:版块ID 
    49  
    50  
    51 是否登录 : 是 
    52 缓存时间 : 无 
    53 是否分页 : 否 
    54  
    55  
    56 返回结果： 
    57 { 
    58    code : 0成功，-1失败 
    59    message : 提示信息 
    60    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    61 } 
    62 }}} 
    63  
    64 ==== 1.1.3 获取用户绑定车友圈列表 ==== 
    65 {{{ 
    66 接口/appapi/1.0/forum/listForumsByUserId.do [GET] 
    67 说明 : 获取用户绑定车友圈列表 
    68 请求参数 ： 
    69  
    70  
    71  
    72 是否登录 : 是 
    73 缓存时间 : 无 
    74 是否分页 : 否 
    75  
    76  
    77 返回结果： 
    78 { 
    79    userId:用户ID 
    80    forumList:[ 
    81       { 
    82          forumId:版块ID 
    83          forumName:版块名字 
    84       } 
    85    ] 
    86  
    87    code : 0成功，-1失败 
    88    message : 提示信息 
    89    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    90 } 
    91 }}} 
    92  
    93  
    94 ==== 1.1.4 判断用户是否绑定某车友圈 ==== 
    95 {{{ 
    96 接口/appapi/1.0/forum/isBound.do [GET] 
    97 说明 : 判断用户是否绑定某车友圈 
    98 请求参数 ： 
    99  
    100    userId:用户ID 
    101    forumId:版块ID 
    102  
    103 是否登录 : 否 
    104 缓存时间 : 无 
    105 是否分页 : 否 
    106  
    107  
    108 返回结果： 
    109 { 
    110    userId:用户ID 
    111    forumId:版块ID 
    112    isBound：是否绑定（0：未绑定；1：已绑定） 
    113  
    114    code : 0成功，-1失败 
    115    message : 提示信息 
    116    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    117 } 
    118 }}} 
    119  
    120 ==== 1.1.5 获取主题对应的动态ID ==== 
    121 {{{ 
    122 接口/appapi/1.0/forum/getDynaByTopicId.do [GET] 
    123 说明 : 获取主题对应的动态ID 
    124 请求参数 ： 
    125  
    126    topicId:主题ID 
    127    createDate:主题创建时间（yyyy-MM-dd hh:mm:ss) 
    128  
    129 是否登录 : 否 
    130 缓存时间 : 无 
    131 是否分页 : 否 
    132  
    133  
    134 返回结果： 
    135 { 
    136    topicId:主题ID 
    137    createDate:主题创建日期 
    138    dynaInfoId:动态ID 
    139  
    140  
    141    code : 0成功，-1失败 
    142    message : 提示信息 
    143    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    144 } 
    145 }}} 
    146  
    147 ==== 1.1.7 获取同城动态列表 ==== 
    148 {{{ 
    149 说明：获取同城动态列表 
    150 接口：/appapi/3.0/dyna/getTongChengDynaList.do [GET] 
    151 请求参数： 
    152       *provinceId 发动态省地区id（必选） 
    153       cityId 发动态市地区id（无则不传） 
    154  
    155 是否登录:否 
    156 缓存时间:无 
    157 是否分页:是 
    158  
    159  
    160 返回 
    161 { 
    162  
    163         dynaList:[ 
    164             { 
    165                 dynaInfoId：动态id， 
    166                 postCount:回复数 
    167                 pubTime: 发布时间, 
    168                 createBy: 创建者ID, 
    169                 nickName:作者昵称, 
    170                 isHasImg: 是否有图片(0:没有，1：有）, 
    171                 petrol: 贡献油值, 
    172                 authorPhoto: 作者头像, 
    173                 isVip：是否认证，（0：否，1：是） 
    174                 praiseCount：点赞数 
    175  
    176                 dynaType:动态类型(1-普通帖子（旧数据包含提问帖子），2-说说动态，3-图片动态，4-提问帖子，5-公告动态，6-活动动态，7-新会员加入动态，8-创建车友会动态） 
    177  
    178                 //以上是动态列表公共字段 
    179                 //下面是根据不同的动态类型，返回不同的字段或内容 
    180                 dynaType == 1，4 
    181                          dynaTargetId:帖子ID 
    182                          content:帖子内容 
    183                          topicTitle: 帖子标题, 
    184                          isPick: 是否是精华（0：不是，1：是，2：是）, 
    185                          isRecommend: 是否是推荐（0：不是，1：是）, 
    186                          forumId: 板块ID, 
    187                          forumName: 板块名称, 
    188                          forumUrl:板块URL 
    189  
    190  
    191  
    192                 dynaType == 2 
    193                          dynaTargetId ：说说动态ID 
    194                          content:说说内容 
    195                          clubName:车友会名字 
    196                          clubUrl:车友会URL 
    197  
    198  
    199  
    200                 images:[ 
    201                      { 
    202                         url:http://xxxx.jpg, 
    203                         //真实宽度 
    204                         width:960, 
    205                         //真实高度 
    206                         height:1000 
    207                       }, 
    208                      { 
    209                         url:http://xxxx.jpg, 
    210                         //真实宽度 
    211                         width:960, 
    212                         //真实高度 
    213                         height:1000 
    214                       } 
    215                 ] 
    216            } 
    217      ] 
    218  
    219         total:总条数 
    220         pageNo:页码 
    221         pageSize:每页条数 
    222         pageCount:总共几页 
    223  
    224         code:0成功，-1失败 
    225         message:提示信息 
    226         version: 接口版本号如1.0，1.0（latest)表示最新版本 
    227  
    228 } 
    229 }}} 
    230  
    231 ==== 1.1.8.1.1. 车友圈首页 banner 和 推荐车友圈 数据 (cms 提供) ==== 
    232 {{{ 
    233 接口：http://www.pcauto.com.cn/forum/club/app/1505/intf6927.html [GET] 
    234 说明：获取车友圈首页 banner 和 推荐车友圈的 id 的列表 (cms 提供) 
    235  
    236 是否分页:否 
    237 是否缓存:否 
    238 是否登陆:否 
    239 请求参数:无 
    240  
    241 返回结果： 
    242 { 
    243     banner 的数据 { 
    244         是否显示 
    245         图片链接 
    246         跳转类型 
    247         跳转链接 
    248     } 
    249     推荐的车友圈的id (多id用,隔开) 
    250 } 
    251 }}} 
    252  
    253 ==== 1.1.8.1.2. 通过推荐的车友圈的id的列表获取每个id对应的车友圈部分的数据.... ==== 
    254 {{{ 
    255 说明 : 通过推荐的车友圈的id的列表获取每个id对应的车友圈部分的数据 
    256  
    257 是否分页:否 
    258 是否缓存:否 
    259 是否登陆:否 
    260 请求参数： 
    261     车友圈的id的列表 (多id用,隔开) 
    262  
    263 返回结果： 
    264 { 
    265     “每个id对应的车友圈的数据”的列表 [ 
    266         { 
    267             车友圈id 
    268             车友圈名 
    269             车友圈logo 
    270             圈子的主题总数（不含回复） 
    271         } 
    272     ] 
    273 } 
    274 }}} 
    275  
    276 === 1.2  论坛相关接口 
    277  
    278 ==== 1.2.1 车友圈信息 ==== 
    279 {{{ 
    280 接口/appapi/1.0/forum/bundUserForum.do [GET] 
    281 说明 : 车友圈信息 
    282 请求参数 ： 
    283           fids:"板块id多个时以','分开" 
    284  
    285  
    286 是否登录 : 否 
    287 缓存时间 : 无 
    288 是否分页 : 否 
    289  
    290  
    291 返回结果： 
    292     { 
    293     "forumList": [ 
    294         { 
    295             "forumDesc": "", 
    296             "forumIcon": "http://img.pconline.com.cn/images/upload/upc/tx/auto5/1304/02/c5/19467254_1364888380062_270x202.jpg", 
    297             "forumId": 14674, 
    298             "forumName": "嘉年华论坛", 
    299             "forumUrl": "http://localhost.pcauto.com.cn/bbs7/forum-14674.html", 
    300             "todayNewPostCount": 1530, 
    301             "topicCount": 14143 
    302         } 
    303     ], 
    304  
    305     "code": 0成功，-1失败, 
    306     "message": 提示信息, 
    307     "version": 接口版本号如1.0，1.0（latest)表示最新版本 
    308     } 
    309 }}} 
    310 ==== 1.2.2 车友圈主题列表 ==== 
    311 {{{ 
    312 接口/appapi/1.0/forum/bundUserForum.do [GET] 
    313 说明 : 车友圈主题列表 
    314 请求参数 ： 
    315  
    316  
    317  
    318 是否登录 : 否 
    319 缓存时间 : 无 
    320 是否分页 : 否 
    321  
    322  
    323 返回结果： 
    324 { 
    325    code : 0成功，-1失败 
    326    message : 提示信息 
    327    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    328 } 
    329 }}} 
    330  
    331  
    332 ==== 1.2.2.1 车友圈主题列表点赞数据.... ==== 
    333 {{{ 
    334 说明 : 车友圈主题列表，判断每个主题的点赞数及当前用户是否已点赞 
    335 请求参数 ： 
    336  
    337 是否登录 : 否 
    338 缓存时间 : 无 
    339 是否分页 : 否 
    340  
    341 请求参数： 
    342 { 
    343     用户ID 
    344     主题ID列表 (多个id用英文逗号分隔开) 
    345 } 
    346  
    347 返回结果： 
    348 { 
    349     点赞数 
    350     是否点赞 
    351 } 
    352 }}} 
    353  
    354 ==== 1.2.3 车友圈置顶主题列表 ==== 
    355 {{{ 
    356 接口/appapi/1/forum/getForumTop.do [GET] 
    357 说明 : 车友圈置顶主题列表 
    358 请求参数 ： 
    359          forumId: 
    360  
    361  
    362 是否登录 : 否 
    363 缓存时间 : 无 
    364 是否分页 : 否 
    365  
    366  
    367 返回结果： 
    368  
    369     "topList": [ 
    370         { 
    371             "containImage": false, 
    372             "createAt": "2015-05-06 11:08:14", 
    373             "isPick": false, 
    374             "nickname": "深海无声", 
    375             "replyCount": 4, 
    376             "title": "提问贴子买车", 
    377             "topicId": 7808466, 
    378             "topicUrl": "http://localhost.pcauto.com.cn/bbs7/topic-7808466.html", 
    379             "updateAt": "2015-05-08 14:04:50", 
    380             "userId": 826717, 
    381             "username": "fit10", 
    382             "viewCount": 1 
    383         } 
    384     ], 
    385       "code": 0成功，-1失败, 
    386     "message": 提示信息, 
    387     "version": 接口版本号如1.0，1.0（latest)表示最新版本 
    388  
    389  
    390 }}} 
    391 ==== 1.2.4 主题终端 ==== 
    392 {{{ 
    393 接口/appapi/1.0/forum/bundUserForum.do [GET] 
    394 说明 : 主题终端 
    395 请求参数 ： 
    396  
    397  
    398  
    399 是否登录 : 否 
    400 缓存时间 : 无 
    401 是否分页 : 否 
    402  
    403  
    404 返回结果： 
    405 { 
    406    code : 0成功，-1失败 
    407    message : 提示信息 
    408    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    409 } 
    410 }}} 
    411  
    412  
    413 ==== 1.2.5 主题跟帖列表 ==== 
    414 {{{ 
    415 接口/appapi/1.0/forum/bundUserForum.do [GET] 
    416 说明 : 主题跟帖列表 
    417 请求参数 ： 
    418  
    419  
    420  
    421 是否登录 : 否 
    422 缓存时间 : 无 
    423 是否分页 : 否 
    424  
    425  
    426 返回结果： 
    427 { 
    428    code : 0成功，-1失败 
    429    message : 提示信息 
    430    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    431 } 
    432 }}} 
    433  
    434  
    435 ==== 1.2.6 主题图片表 ==== 
    436 {{{ 
    437 接口/appapi/1/forum/getImagesByTid.do [GET] 
    438 说明 : 主题图片表 
    439 请求参数 ： 
    440         topicId: 
    441         size: 所需的图片张数 
    442  
    443  
    444 是否登录 : 否 
    445 缓存时间 : 无 
    446 是否分页 : 否 
    447  
    448  
    449 返回结果： 
    450 { 
    451     "imgList": [ 
    452         { 
    453             "exLink": 0, 
    454             "height": 529, 
    455             "seq": 1, 
    456             "url": "http://img.pconline.com.cn/images/upload/upc/tx/bbs6/1406/13/c5/35235990_1402638068263_1024x1024.png", 
    457             "width": 684 
    458         }, 
    459    ], 
    460    imgSize: 12, 
    461    code : 0成功，-1失败 
    462    message : 提示信息 
    463    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    464 } 
    465 }}} 
    466  
    467  
    468 === 1.3  修改个人资料相关接口 
    469  
    470 ==== 1.3.1 修改个人资料 ==== 
    471 {{{ 
    472 接口/appapi/1.0/user/updateUserInfo.do [POST] 
    473 说明 : 修改个人资料 
    474 请求参数 ： 
    475  
    476   nickName：昵称 
    477   gender：姓别 (0:男,1:女） 
    478   birthday：出生日期(yyyy-MM-dd) 
    479   cityId: 城市ID 
    480   cityName: 城市名字 
    481   provinceId: 省ID 
    482   provinceName: 省份名字 
    483   brandId: 品牌ID 
    484   brandName：品牌名字 
    485   serialId: 车系ID 
    486   serialName: 车系名字 
    487  
    488 是否登录 : 是 
    489 缓存时间 : 无 
    490 是否分页 : 否 
    491  
    492  
    493 返回结果： 
    494 { 
    495    code : 0成功，-1失败 
    496    message : 提示信息 
    497    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    498 } 
    499 }}} 
    500  
    501  
    502 ==== 1.3.2 获取个人资料 ==== 
    503 {{{ 
    504 接口/appapi/1.0/user/getUserInfo.do [GET] 
    505 说明 : 修改个人资料 
    506 请求参数 ： 
    507  
    508   userId: 用户ID 
    509  
    510 是否登录 : 否 
    511 缓存时间 : 无 
    512 是否分页 : 否 
    513  
    514  
    515 返回结果： 
    516  
    517 { 
    518    nickName：昵称 
    519    gender：姓别 (0:男,1:女） 
    520    birthday：出生日期(yyyy-MM-dd) 
    521    provinceId: 省ID 
    522    provinceName: 省名字 
    523    cityId: 城市ID 
    524    cityName: 城市名字 
    525    brandId: 品牌ID 
    526    brandName：品牌名字 
    527    serialId: 车系ID 
    528    serialName: 车系名字 
    529  
    530    code : 0成功，-1失败 
    531    message : 提示信息 
    532    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    533 } 
    534 }}} 
    535  
    536 ==== 1.3.3 判断个人资料是否完整 ==== 
    537 {{{ 
    538 接口/appapi/1.0/user/isCompleteUserInfo.do [GET] 
    539 说明 : 判断个人资料是否完整 
    540 请求参数 ： 
    541  
    542   userId: 用户ID 
    543  
    544 是否登录 : 否 
    545 缓存时间 : 无 
    546 是否分页 : 否 
    547  
    548  
    549 返回结果： 
    550  
    551 { 
    552    userId: 用户ID 
    553    isComplete: 资料是否完整（0：不完整；1：完整） 
    554  
    555    code : 0成功，-1失败 
    556    message : 提示信息 
    557    version : 接口版本号如1.0，1.0（latest)表示最新版本 
    558 } 
    559 }}} 
     18=== 车友会相关接口 
    56019 
    56120== 2. mrobot 合并 ==