协会官网接口v1.1

1.0
创建接口

1.1
更新了关于评论的接口,简化了接口的使用,增加了意见反馈部分和oauth部分,接口时间格式统一为时间戳


接口格式

RequestAddress:
//请求发送的地址
"我是一个地址"

RequestMethod:
//发送请求的形式,post/get
"我是一个请求类型"

Request:
//请求的所需内容
{
    //我是一个json数组
    object=>{
      //我是一个对象,object是我的名字
      title : (string),
      //title是我的属性名,string是我的类型      
    },
    key : (int),
    //我是数组中的一个键,key是名字,int是类型
}

Respond:
//请求的回应
[ 形式和上面的一样,也是json数组 ]

近期活动部分

RequestAddress: 

RequestMethod:
get

Request: 
NULL

Respond: 
{
    //注意activity的对象数组可能有一个或者是两个
    //也就是说activity2这个东西不一定存在
    "activity"=>
    [{
        "title" : (string),   //活动标题,无限杯电子设计大赛
        "content" : (string), //活动简介
        "schedule"=>
        [{ //这里是日程表
          "stage" : (string),  //阶段
          "beginTime" : (int), //时间戳,开始时间
          "endTime" : (int),   //时间戳,结束时间
          "place" : (string),  //地点
        },
        {
        },
        {
        },
        {
        }],
        "signUpLink" : (string)  //报名的链接,这个在为false的情况下,说明报名未开始或者已经截止
        "posterLink" : (string)  //海报的链接
    },//activity1
    {
    }],//activity2
}

活动报道部分

一、活动报道
RequestAddress:

RequestMethod:
get

Request:
{
    "page" : (int)  //访问的页码,首次访问默认应该发送1,也就是第一页
}

Respond:
{
    "totalPage" : (int)  //总的页数
    //注意,报道为1-3个,不一定都是三个
    "report"=>
    [{  //第一个报道
        "reportId" : (string),        //文章的id号
        "title" : (string),           //报道的标题
        "abstract" : (string),        //报道的简介
        "updateTime" : (int),         //报道的更新时间,对应于日期
        "surfacePlotUrl" : (string),  //标题图的链接
    },
    {  //第二个报道
        "reportId" : (string),      
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
    },
    {  //第三个报道    
        "reportId" : (string),  
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
    }]
}
二、活动报道详情
RequestAddress:

RequestType:
get

Request:
[
    "reportId" : (int)  //报道的id号
]

Respond:
{
    "reportUrl" : (string)      //报道的文章地址
    "commentTotalPage" : (int)  //评论总的页数
    //每页的评论最多有三条
    "comment"=>
    [{
        "user" : (string),          //评论人
        "userFigureUrl" : (string), //评论人的头像地址
        "createTime" : (int),       //创建时间戳
        "content" : (string),       //评论内容
    },
    {
        //同上
    },
    {
        //同上
    }]
}
三、评论翻页
RequestAddress:

RequestType:
get

Request:
{
    "reportId" : (int)               //报道的id号
    "commentCurrentPage" : (string)  //评论的页码
}

Respond:
{
    //注意评论不一定有三个
    "comment"=>
    [{
        "user" : (string),          //评论人
        "userFigureUrl" : (string), //评论人的头像地址
        "createTime" : (int),       //创建时间戳
        "content" : (string),       //评论内容
    },
    {
        //同上
    },
    {
        //同上
    }]
}
四、提交评论
RequestAddress:

RequestType:
post

Request:
{
    "content" : (string) //评论的内容
    "reportId" : (int)   //报道的id号
}

Respond:
{
    "state" : (int)  //0代表失败,1代表成功,2代表没有登录
}

作品集锦部分

RequestAddress:

RequestMethod:
get

Request:
{
    "page" : (int)  //访问的页码,首次访问默认应该发送1,也就是第一页
}

Respond:
{
    "totalPage" : (int)  //总的页数
    //注意,作品为1-3个,不一定都是三个
    "works"=>
    [{  //第一个作品
        "title" : (string),           //作品的标题
        "abstract" : (string),        //作品的简介
        "updateTime" : (int),         //作品的更新时间,对应于日期
        "surfacePlotUrl" : (string),  //标题图的链接
        "worksUrl" : (string),        //文章的链接
    },
    {  //第二个作品   
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
        "worksUrl" : (string),     
    },
    {  //第三个作品     
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
        "worksUrl" : (string),    
    }]
}

维修技巧部分

一、维修技巧
RequestAddress:

RequestMethod:
get

Request:
{
    "page" : (int)  //访问的页码,首次访问默认应该发送1,也就是第一页
}

Respond:
{
    "totalPage" : (int)  //总的页数
    //注意,维修技巧为1-3个,不一定都是三个
    "skill"=>
    [{  //第一个维修技巧
        "title" : (string),           //维修技巧的标题
        "abstract" : (string),        //维修技巧的简介
        "updateTime" : (int),         //维修技巧的更新时间,对应于日期
        "surfacePlotUrl" : (string),  //标题图的链接
        "skillId" : (string),         //文章的id号
    },
    {  //第二个维修技巧      
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
        "skillId" : (string),     
    },
    {  //第三个维修技巧     
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
        "skillId" : (string),    
    }]
}
二、维修技巧文章
RequestAddress:

RequestType:
get

Request:
{
    "skillId" : (int)  //维修技巧的id号
}

Respond:
{
    //评论数量可能为0,1,2,3
    "skillUrl" : (string)       //维修技巧的文章地址
    "commentTotalPage" : (int)  //评论总的页数
    "comment"=>
    [{
        "user" : (string),          //评论人
        "userFigureUrl" : (string), //评论人的头像地址
        "createTime" : (int),       //创建时间戳
        "content" : (string),       //评论内容
    },
    {
        //同上
    },
    {
        //同上
    }]
}
三、评论翻页
RequestAddress:

RequestType:
get

Request:
{
    "skillId" : (int)                //维修技巧的id号
    "commentCurrentPage" : (string)  //评论的页码
}

Respond:
{
    //注意评论不一定有三个
    "comment"=>
    [{
        "user" : (string),          //评论人
        "userFigureUrl" : (string), //评论人的头像地址
        "createTime" : (int),       //创建时间戳
        "content" : (string),       //评论内容
    },
    {
        //同上
    },
    {
        //同上
    }]
}
四、提交评论
RequestAddress:

RequestType:
post

Request:
{
    "content" : (string) //评论的内容
    "skillId" : (int)    //维修技巧的id号
}

Respond:
{
    "state" : (int)  //0代表失败,1代表成功,2代表未登录
}

预约申请部分

一、获得预约信息
RequestAddress:

RequestType:
get

Request:
NULL

Respond:
{
    "isOrder" : (int),    //是否该用户有预约维修
    "underExam" : (int),  //在有预约的时候显示预约审核进度,0为未审核,1为通过,2为不通过
                          //在没有预约的时候一定为0 
}
二、进行预约
//这个接口只有在这个用户没有预约过的时候开放
//如果该用户当前有预约,那么这个接口一定会返回失败信息
RequestAddress:

RequestType:
post

Request:
{
    "name" : (string),        //预约人的名字
    "phoneNumber" : (string), //手机号,默认11位,格式非法的电话号码无法通过预约
    "campus" : (int),         //校区信息,南校为0,北校为1
    "dormitory" : (string),   //宿舍的信息,最长30
    "itemName" : (string),    //修理物品的名字,最长80
    "description" : (string), //修理物品损坏情况的具体描述
}

Respond:
{
    isSuccess : (int), //0表示失败,1表示成功
}

意见反馈部分

这里的UI有一些问题,所以加了分页

一、获取反馈
RequestAddress:

RequestType:
get

Request:
{
    "page" : (int), //访问的页码,第一次进入应该为1
}

Respond:
{
    "totalPage" : (int) //评论的总页数
    //每一页反馈最多有三条
    "feedback"=>
    [{
        "feedbackCreateTime" : (int), //反馈的创建时间
        "feedbackContent" : (string), //反馈的内容 
        "respondCreateTime" : (int),  //回应的创建时间
        "respondContent" : (string),  //回应的内容
    },
    {
    },
    {
    }]
}
二、提交反馈
RequestAddress:

RequestType:
post

Request:
{
    "content" : (string), //反馈的内容
}

Respond:
{
    "state" : (int), //0表示失败,1成功,2未登录
}

QQ授权部分

一、获取用户信息

该接口用于用户授权结束后获取用户信息,或者说是用户更改了自身的qq信息,想要刷新的情况
注意:该接口每日调用数量有限,预计为每日一次

RequestAddress: (暂定OAuth/get-user-info-refresh)

RequestType:
post

Request:

Response:
{
    state:(int)           //成功为1,失败为0,并且在失败的情况下以下的参数全部没有           
    nick_name:(string)    //用户在QQ空间的昵称,如"Peter"
    figureurl:(string)    //大小为40×40像素的QQ头像URL,如"http://qzapp.qlogo.cn/qzapp/111111/942FEA70050EEAFBD4DCE2C1FC775E56/30"
}
二、重新获取用户信息

该接口用于在本地缓存的用户信息丢失的情况下从后端数据库重新获取用户信息

RequestAddress: (暂定OAuth/get-user-info)

RequestType:
get

Request:

Response:
{
    state:(int)           //成功为1,失败为0,并且在失败的情况下以下的参数全部没有
    nick_name:(string)    //用户在QQ空间的昵称,如"Peter"
    figureurl:(string)    //大小为40×40像素的QQ头像URL,如"http://qzapp.qlogo.cn/qzapp/111111/942FEA70050EEAFBD4DCE2C1FC775E56/30"
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,524评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,869评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,813评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,210评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,085评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,117评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,533评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,219评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,487评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,582评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,362评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,218评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,589评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,899评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,176评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,503评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,707评论 2 335

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,062评论 25 707
  • 前台部分 QQ授权登陆部分 QQ授权登陆流程后台人员看,前台人员感兴趣看一下,我写的比较渣 用户点击登陆按钮发起的...
    满堂风来阅读 1,031评论 0 0
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,945评论 4 60
  • 社交红利阅读笔记 书名:社交红利(修订升级版) 作者:徐志斌 出版社:中信出版社 正文前笔记: 推荐序1摘要 社交...
    凫水阅读 8,864评论 4 26
  • 头部玩家也来参与在线教育了,必须得关注。在认真读完这本“关于知识服务的全部心法和方法”的手册之后,对某些理念还是很...
    王莹Erin阅读 958评论 1 3