“用户:wuhongjun”的版本间的差异

来自Blueidea
跳转至: 导航搜索
(以“== 老师发各种接口定义 == 手机api 推送api (注意:只是预定义,后续可能会修改个别接口)”替换内容)
 
(未显示同一用户的12个中间版本)
第1行: 第1行:
手机API接口
+
== 老师发各种接口定义 ==
 
+
[[手机api]]
{{首页布局
+
  [[推送api]]
|颜色代码
+
(注意:只是预定义,后续可能会修改个别接口)
|标题名
+
|内容模板名称
+
}}
+
    "result":0,(0:表示成功,负数表示传入参数有错,正数表示服务器执行出现错误)
+
    具体的业务数据
+
 
+
== 登陆接口 ==
+
'''请求地址''':http://192.168.1.5/teach/api/login<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|username
+
| true || string ||用户名或者email
+
|-
+
!scope="row"|authcode
+
| true || string || 密码经过md5加密后的字符串
+
|}
+
'''返回结果''':JSON格式
+
<source lang="javascript">
+
{
+
    "result":0,       
+
    "data":{}// 用户信息
+
}
+
</source>
+
 
+
== 登出接口 ==
+
'''请求地址''':http://192.168.1.5/teach/api/logout<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|username
+
| true || string ||用户名或者email
+
|}
+
'''返回结果''':JSON格式
+
<source lang="javascript">
+
{
+
    "result":0
+
}
+
</source>
+
 
+
== 密码修改接口 ==
+
'''请求地址''':http://192.168.1.5/teach/api/updatepwd<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|username
+
| true || string ||用户名或者email
+
|-
+
!scope="row"|oldpwd
+
| true || string ||md5加密的旧密码
+
|-
+
!scope="row"|newpwd
+
| true || string ||md5加密的新密码
+
|}
+
'''返回结果''':JSON格式
+
<source lang="javascript">
+
{
+
    "result":0
+
}
+
</source>
+
 
+
 
+
== 用户信息读取 ==
+
'''请求地址''':http://192.168.1.5/teach/api/getuser<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|uid
+
| true || int||用户id
+
|}
+
'''返回结果''':JSON格式
+
<source lang="javascript">
+
{
+
    "result":0,
+
    "data":{
+
        username, // 用户名
+
        realname, // 真是姓名
+
        age,  // 年龄
+
        birthyear, // 生日年份
+
        birthmonth, // 生日月份
+
        birthday, // 生日是哪天
+
        ....
+
    }
+
}
+
</source>
+
 
+
== 用户资料修改(还未完成) ==
+
'''请求地址''':http://192.168.1.5/teach/api/updateuser<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|uid
+
| true || int||用户id
+
|-
+
!scope="row"|type
+
| true || string||分类('base'-->基本信息,'contact'-->联系方式,'edu'-->教育情况,'work'-->工作情况,'info'-->个人信息)
+
|-
+
!scope="row"|profile
+
| true || array||针对type字段,相对应的信息
+
|}
+
'''返回结果''':JSON格式
+
<source lang="javascript">
+
{
+
    "result":0
+
}
+
</source>
+
 
+
== 推送接口地址 ==
+
'''请求地址''':http://192.168.1.5/teach/api/push<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|token
+
| true || string||push平台的token
+
|-
+
!scope="row"|appid
+
| true || string||push平台的appid
+
|-
+
!scope="row"|apikey
+
| true || string||push平台的apikey
+
|-
+
!scope="row"|secretkey
+
| true || string||push平台的secretkey
+
|-
+
!scope="row"|id
+
| true || string||push平台的id
+
|-
+
!scope="row"|name
+
| true || string||push平台的name
+
|}
+
'''返回结果''':JSON格式,status=0表示操作成功
+
<source lang="javascript">
+
{
+
    "result":0
+
}
+
</source>
+
 
+
== 获取单条帖子信息 ==
+
'''请求地址''':http://192.168.1.5/teach/api/get_signal_thread<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|tid
+
| true || string||帖子ID
+
|}
+
'''返回结果''':JSON格式,status=0表示操作成功
+
<source lang="javascript">
+
{
+
    "result":0,
+
    "data":{
+
        author:'',// 作者
+
        clsname:'',// 所在班级
+
        subject:'',// 主题
+
        content:'',// 内容
+
        dateline:''// 发帖时间
+
    }
+
}
+
</source>
+
 
+
== 获取多条帖子信息 ==
+
'''请求地址''':http://192.168.1.5/teach/api/get_many_thread<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|clsid
+
| false|| int||班级id
+
|-
+
!scope="row"|startid
+
| true || int||起始id
+
|-
+
!scope="row"|number
+
| true || int||获取多少条
+
|-
+
!scope="row"|order
+
| true || string||排序字段(可以逗号分隔,如id asc,name desc)
+
|-
+
|}
+
'''返回结果''':JSON格式,status=0表示操作成功
+
<source lang="javascript">
+
{
+
    "result":0,
+
    "data"[{
+
        id,
+
        subject, // 标题
+
        dateline,  // 发表时间
+
        lastpost,  // 最后发表
+
        lastposter,// 最后发表人
+
        views,// 浏览次数
+
        replies,// 回复次数
+
        displayorder,// 显示顺序
+
        highlight,// 是否高亮
+
        digest,// 是否精华
+
    },{},{}]
+
}
+
</source>
+
 
+
== 获取用户班级信息 ==
+
'''请求地址''':http://192.168.1.5/teach/api/get_user_class<br>
+
'''请求方式''':POST<br>
+
'''请求参数''':
+
:{| class="wikitable" style="font-size:13px;"
+
! 参数名称
+
! 必选
+
! 类型及范围
+
! 说明
+
|-
+
!scope="row"|uid
+
| false|| int||用户id
+
|}
+
'''返回结果''':JSON格式,status=0表示操作成功
+
<source lang="javascript">
+
{
+
    "result":0,
+
    "data":{
+
      clsid:'',// 班级id
+
      clsname:'',// 班级名称
+
      grade:'',// 所属年级
+
      areaname:'',// 所在城市区域
+
      schname:'',// 学校名称
+
      dateline:''// 班级创建时间
+
    }
+
}
+
</source>
+

2014-07-29T10:17:19的最后版本

老师发各种接口定义

手机api
推送api

(注意:只是预定义,后续可能会修改个别接口)