Changes between Version 1 and Version 2 of piebbs_intf


Ignore:
Timestamp:
07/04/2016 10:27:05 AM (10 years ago)
Author:
huangping
Comment:

app相关接口添加

Legend:

Unmodified
Added
Removed
Modified

  • piebbs_intf

    v1 v2  
    22== 最数码论坛相关接口 == 
    33 
     4注：（PS：可以参考 电脑网APP、亲子网APP进行开发）[[BR]] 
     51．+为本次新增接口，*为本次有改动的接口。[[BR]] 
     62．接口公共字段说明：status表示状态，message表示操作结果说明。其中status字段值的含义如下：[[BR]] 
     7 
     8        STATUS_ERROR = -1;      //错误[[BR]] 
     9        STATUS_SUCCESS = 0;     //成功[[BR]] 
     10        STATUS_NO_RIGHT = 1;    //没有权限[[BR]] 
     11        STATUS_PARAM_WRONG = 2;         //参数错误[[BR]] 
     12        STATUS_CONTENT_OVERFLOW = 3;    //内容超出长度[[BR]] 
     13        STATUS_EXISTS = 4;              //数据已经存在[[BR]] 
     14        STATUS_NOT_FOUND = 5;   //数据查找不到[[BR]] 
     15        STATUS_NO_LOGIN = 6;    //没有登录[[BR]] 
     16        STATUS_USER_LOCK = 7;   //用户被锁[[BR]] 
     17        STATUS_IP_LOCK = 8;     //IP被锁[[BR]] 
     18 
     19 
     20最数码开发环境地址： 
     21[http://dev33.pconline.com.cn/admin.do][[BR]] 
     22最数码测试环境： 
     23[http://v15.pconline.com.cn/admin.do][[BR]] 
     24最数码线上环境： 
     25[http://piebbs.pconline.com.cn/admin.do][[BR]] 
     26 
     27---- 
     28 
     29'''最数码版块列表页接口'''[[BR]] 
     30http://xxx.pconline.com.cn/rest/forums/22 
     31[[BR]] 
     32请求方式：HTTP GET[[BR]] 
     33说明：最后数字是板块ID[[BR]] 
     34缓存：[[BR]] 
     35参数：[[BR]] 
     36   pageNo: 当前页 默认1[[BR]] 
     37   pageSize:一页显示几条数据，默认25[[BR]] 
     38   filter:帖子类型（传递filter=type表示需要所有类型）（filter=pick表示需要精华帖） 
     39   fval:版块分类（如讨论，晒物，经验，交易）[[BR]] 
     40   orderby ：按照什么排序（默认是降序）[[BR]] 
     41   最新回复时间：replyat[[BR]] 
     42   最新发表时间：postat[[BR]] 
     43   maxLength:标题最大字符串数目[[BR]] 
     44   showTop：是否展示置顶帖（boolean）,置顶帖单独出，不算在总数中，因为置顶帖不超过10个,显示置顶帖的条件是第一页(pageNo=1)并且fval为空并且showTop为true[[BR]] 
     45   isCensorFirst ：非必须，看需求是否需要，是否先审后出(true/false)，如果为true并且帖子未审，则title为”该帖子正在审核中”、message为”该帖子正在审核中”[[BR]] 
     46 
     47返回(json格式)： 
     48{[[BR]] 
     49        forum: { 
     50                bbs: 2,[[BR]] 
     51                forumId: 22,[[BR]] 
     52                name: "今日聚超值讨论区",[[BR]] 
     53                parentId: 2,[[BR]] 
     54                uuid: "123aerhn%32gt45" 
     55        },[[BR]] 
     56        pageNo: 1,[[BR]] 
     57        pageSize: 1,[[BR]] 
     58        topTopicList:  
     59                { 
     60                        author: {[[BR]] 
     61                                name: "geniusyys",[[BR]] 
     62                                nickname: "荒木",[[BR]] 
     63                                userFace: "XXX",[[BR]] 
     64                                userId: 20839026[[BR]] 
     65                        },[[BR]] 
     66                        createAt: 1405518128000,[[BR]] 
     67                        floor: 21,[[BR]] 
     68                        formatCreateAt: "2014-07-16 21:42",[[BR]] 
     69                        image: "",[[BR]] 
     70                        lastPostAt: 1413442722000,[[BR]] 
     71                        message: "交易区禁止",[[BR]] 
     72                        replyCount: 20,[[BR]] 
     73                        title: "禁止发多个交易帖子，新东西请在主贴更新",[[BR]] 
     74                        topicId: 104776,[[BR]] 
     75                        uri: "XXX",[[BR]] 
     76                        view: 821[[BR]] 
     77                }[[BR]] 
     78        ],[[BR]] 
     79        topicList: [ 
     80                { 
     81                        author: { 
     82                                name: "fit10",[[BR]] 
     83                                nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",[[BR]] 
     84                                userFace: "XXXX",[[BR]] 
     85                                userId: 826717[[BR]] 
     86                        },[[BR]] 
     87                        createAt: 1463033025000,[[BR]] 
     88                        floor: 1,[[BR]] 
     89                        formatCreateAt: "2016-05-12 14:03",[[BR]] 
     90                        image: "",[[BR]] 
     91                        lastPostAt: 1463033025000,[[BR]] 
     92                lastPoster: { 
     93                        lastPostAt: "2015-01-22 15:56",[[BR]] 
     94                        name: "qz23180228",[[BR]] 
     95                        nickname: "qz23180228",[[BR]] 
     96                        userId: 23180228[[BR]] 
     97                },[[BR]] 
     98                isContainImage: false,[[BR]] 
     99                        message: "按时到啥时候发奖金",[[BR]] 
     100                        replyCount: 0,[[BR]] 
     101                        title: "今天是好日子",[[BR]] 
     102                        topicId: 122451,[[BR]] 
     103                        uri: "XXXX",[[BR]] 
     104                        view: 4[[BR]] 
     105                }[[BR]] 
     106        ],[[BR]] 
     107        total: 23550[[BR]] 
     108} 
     109结果说明： 
     110   topTopicList 这是置顶帖列表[[BR]] 
     111   topicList 这是主题表列表[[BR]] 
     112   isContainImage 是否包含图片true或者false[[BR]] 
     113 
     114   如果是精华帖会多出 isPick:true , flag : ”精”这个字段[[BR]] 
     115 
     116   如果帖子是本站置顶，则会多出isForumTop ：true字段[[BR]] 
     117 
     118   如果符合帖子审核通过、作者状态正常并且帖子有图片就会出imgUrls 大小400x的三张图片[[BR]] 
     119 
     120   如果帖子作者不存在或者帖子作者被锁，则message内容为“用户被封，内容屏蔽”[[BR]] 
     121 
     122   如果帖子作者不为空，则会显示作者相关信息[[BR]] 
     123 
     124   author: {name: "",   nickname: "",   userFace: ,     userId: },[[BR]] 
     125 
     126   如果最后回复作者不为空，则会出最后回复作者信息[[BR]] 
     127 
     128   lastPoster: {name: "",       nickname: "",   userFace: ,     userId: },[[BR]] 
     129 
     130'''最数码发主帖接口'''[[BR]] 
     131http://xxx.pconline.com.cn/rest/forums/22 
     132[[BR]] 
     133请求方式：HTTP POST[[BR]] 
     134说明：最后数字是板块ID[[BR]] 
     135缓存：[[BR]] 
     136参数：[[BR]] 
     137   title: 标题[[BR]] 
     138   message:帖子内容[[BR]] 
     139   type:帖子类型[[BR]] 
     140   sendMsg: 是否发送消息（false/true）[[BR]] 
     141   agent:来源 (1代表ios移动端帖子)(2代表Android移动端帖子）或者按照亲子网电脑网那样传递user-agent参数[[BR]] 
     142返回(json格式)：[[BR]] 
     143{ 
     144   Location:url, [[BR]] 
     145   status:0 [[BR]] 
     146}[[BR]] 
     147参数说明：[[BR]] 
     148  Status为0的时候说明发帖成功，否则发帖不成功[[BR]] 
     149 
     150 
     151'''最数码发回帖接口'''[[BR]] 
     152http://xxx.pconline.com.cn/rest/topics/122461 
     153[[BR]] 
     154请求方式：HTTP POST[[BR]] 
     155说明：最后数字是帖子ID[[BR]] 
     156缓存：[[BR]] 
     157参数：[[BR]] 
     158        message:回帖内容[[BR]] 
     159        replyToId：回复ID[[BR]] 
     160        sendMsg: 是否发送消息（false/true） 
     161        agent:来源 (1代表ios移动端帖子)(2代表Android移动端帖子）或者按照亲子网电脑网那样传递user-agent参数[[BR]] 
     162返回(json格式)：[[BR]] 
     163{ 
     164  Location:url, [[BR]] 
     165  status:0 [[BR]] 
     166}[[BR]] 
     167 
     168参数说明：[[BR]] 
     169  Status为0的时候说明发回帖成功，否则发回帖不成功[[BR]] 
     170 
     171'''最数码获取帖子内容信息接口(包括了回帖内容)'''[[BR]] 
     172http://xxx.pconline.com.cn/rest/topics/122461 
     173[[BR]] 
     174请求方式：HTTP GET[[BR]] 
     175说明：最后数字是帖子ID[[BR]] 
     176缓存：[[BR]] 
     177参数： 
     178        pageNo:第几页 [[BR]] 
     179        authorId：作者ID（有传递表示只看作者回复的内容）[[BR]] 
     180        desc：是否按楼层倒序，不传递表示按楼层升序[[BR]] 
     181        agent:来源 (1代表ios移动端帖子)(2代表Android移动端帖子）或者按照亲子网电脑网那样传递user-agent参数[[BR]] 
     182        isCensorFirst ：非必须，看需求是否需要，是否先审后出(true/false)，如果为true并且帖子未审，则title为”该帖子正在审核中”、message为”该帖子正在审核中”[[BR]] 
     183 
     184返回(json格式)：[[BR]] 
     185{ 
     186        "curAllImage":[          
     187         "p1_1_XXX",[[BR]] 
     188         "p1_2_XXX"[[BR]] 
     189        ],[[BR]] 
     190        pageNo: 1,[[BR]] 
     191        pageSize: 10,[[BR]] 
     192        postList: [ 
     193                { 
     194                        agent: 0,[[BR]] 
     195                        author: { 
     196                                level: "最数码龙头",[[BR]] 
     197                                name: "fit10",[[BR]] 
     198                                nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",[[BR]] 
     199                                userFace: "XXX",[[BR]] 
     200                                userId: 826717 
     201                        },[[BR]] 
     202                        createAt: 1467353045000,[[BR]] 
     203                        floor: 1,[[BR]] 
     204                        message: "这个就是内容",[[BR]] 
     205                        postId: 1873171,[[BR]] 
     206                        status: 0[[BR]] 
     207                },[[BR]] 
     208                { 
     209                        agent: 0,[[BR]] 
     210                        author: { 
     211                                level: "最数码龙头",[[BR]] 
     212                                name: "fit10",[[BR]] 
     213                                nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",[[BR]] 
     214                                userFace: "XXX",[[BR]] 
     215                                userId: 826717[[BR]] 
     216                        },[[BR]] 
     217                        createAt: 1467353630000,[[BR]] 
     218                        floor: 2,[[BR]] 
     219                        message: "我来回复看看",[[BR]] 
     220                        postId: 1873172,[[BR]] 
     221                        status: 0[[BR]] 
     222                } 
     223        ],[[BR]] 
     224        topic: { 
     225                author: { 
     226                        level: "最数码龙头",[[BR]] 
     227                        name: "fit10",[[BR]] 
     228                        nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",[[BR]] 
     229                        userFace: "XXX",[[BR]] 
     230                        userId: 826717[[BR]] 
     231                }, 
     232                bbsId: 66,[[BR]] 
     233                createAt: 1467353045000,[[BR]] 
     234                favoriteCount: 0,[[BR]] 
     235                forumId: 66,[[BR]] 
     236                forumName: "网络检测",[[BR]] 
     237                forumUuid: "",[[BR]] 
     238                lastPostAt: 1467353630000,[[BR]] 
     239                lastPoster: { 
     240                        name: "fit10",[[BR]] 
     241                        nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",[[BR]] 
     242                        userId: 826717[[BR]] 
     243                },[[BR]] 
     244                replyCount: 1,[[BR]] 
     245                title: "第一次发帖",[[BR]] 
     246                uri: "XXX",[[BR]] 
     247                view: 5[[BR]] 
     248        },[[BR]] 
     249        total: 2 
     250} 
     251 
     252参数说明： 
     253        curAllImage ：帖子图片[[BR]] 
     254        postList: 表示的回帖内容[[BR]] 
     255        topic: 表示主题内容[[BR]] 
     256 
     257        如果帖子作者被锁，则message内容为“用户被封，内容屏蔽”[[BR]] 
     258 
     259        如果isCensorFirst 为true并且回帖未审，则message为 “该帖子正在审核中，请稍后查看！”[[BR]] 
     260 
     261        如果帖子是Html帖子，则message 为 “抱歉，暂不支持HTML贴:(”[[BR]] 
     262 
     263 
     264'''最数码获取我的收藏帖子信息接口'''[[BR]] 
     265http://xxx.pconline.com.cn/intf/user/_favTopics.jsp 
     266[[BR]] 
     267请求方式：GET[[BR]] 
     268说明：获取用户收藏的帖子[[BR]] 
     269缓存：[[BR]] 
     270参数：[[BR]] 
     271        userId: 用户ID[[BR]] 
     272        pageNo：当前第几页[[BR]] 
     273        pageSize：一页显示几条数据（不传递默认5）[[BR]] 
     274        fid : 版块ID[[BR]] 
     275        onlyShowForum : 是否只展示fid版块（false/true）[[BR]] 
     276        callback :回调函数，非必须[[BR]] 
     277返回(json格式)：[[BR]] 
     278{ 
     279        list: [ 
     280                { 
     281                        authorName: "liuyijiabailie",[[BR]] 
     282                        authorNickName: "liuyijiabailie",[[BR]] 
     283                        authorUrl: "XXX",[[BR]] 
     284                        createAt: "15-01-15 21:43",[[BR]] 
     285                        favoriteCount: 1,[[BR]] 
     286                        favoriteId: 20012,[[BR]] 
     287                        forumName: "今日聚超值讨论区",[[BR]] 
     288                        forumUrl: "XXX",[[BR]] 
     289                        image: "XXX",[[BR]] 
     290                        isContainImage: true,[[BR]] 
     291                        isNew: false,[[BR]] 
     292                        lastPostAt: "15-01-22 15:01",[[BR]] 
     293                        lastPosterNickname: "liuyijiabailie",[[BR]] 
     294                        lastPosterUrl: "XXX",[[BR]] 
     295                        replyCount: 4,[[BR]] 
     296                        title: "博朗340S与WF1S",[[BR]] 
     297                        topicId: 121668,[[BR]] 
     298                        url: "XXX",[[BR]] 
     299                        viewCount: 138[[BR]] 
     300                }, 
     301        ],[[BR]] 
     302        listCount: 2 
     303} 
     304 
     305参数说明： 
     306 
     307 
     308'''最数码获取我的帖子信息接口'''[[BR]] 
     309http://xxx.pconline.com.cn/intf/user/_topics.jsp 
     310[[BR]] 
     311请求方式：[[BR]] 
     312说明：获取用户自己的帖子的帖子[[BR]] 
     313缓存：缓存15分钟[[BR]] 
     314参数：[[BR]] 
     315        userId: 用户ID[[BR]] 
     316        pageNo：当前第几页[[BR]] 
     317        pageSize：一页显示几条数据[[BR]] 
     318        fid : 版块ID[[BR]] 
     319        orderBy : 根据什么排序(例如createAt)[[BR]] 
     320        isAsc : 是否升序，false/true[[BR]] 
     321        maxLength：帖子内容显示最大长度[[BR]] 
     322        callback :回调函数，非必须[[BR]] 
     323返回(json格式)：[[BR]] 
     324{ 
     325        list: [ 
     326                { 
     327                        censored: 0,[[BR]] 
     328                        fid: 22,[[BR]] 
     329                        floor: 1,[[BR]] 
     330                        forumName: "今日聚超值讨论区",[[BR]] 
     331                        forumUrl: "XXX",[[BR]] 
     332                        image: "",[[BR]] 
     333                        isContainImage: false,[[BR]] 
     334                        isNew: false,[[BR]] 
     335                        lastPostAt: "16-05-12 14:03",[[BR]] 
     336                        message: "按时到啥时候发奖金",[[BR]] 
     337                        pick: 0,[[BR]] 
     338                        pid: 1873161,[[BR]] 
     339                        replyCount: 0,[[BR]] 
     340                        title: "今天是好日子",[[BR]] 
     341                        topicCreateAt: 1463033025000,[[BR]] 
     342                        topicId: 122451,[[BR]] 
     343                        url: "XXX",[[BR]] 
     344                        userName: "太平洋电脑网论坛帖子仅代表作者本人意见",[[BR]] 
     345                        userUrl: "XXX",[[BR]] 
     346                        viewCount: 1[[BR]] 
     347                }, 
     348        ],[[BR]] 
     349        listCount: 10 
     350} 
     351 
     352参数说明： 
     353 
     354censored;   //审核状态 0 未审 1 已审[[BR]] 
     355pick ; 精华类型 (0代表不是精华) (1代表精华1)( 2代表精华2)[[BR]]