手机api

来自Blueidea
wuhongjun（讨论 | 贡献）2014-08-12T16:53:39的版本 （→‎注册手机设备的uuid）

跳转至： 导航、 搜索

返回格式说明 

 "result":0,// (0:表示成功,负数表示传入参数有错，正数表示服务器执行出现错误,参见下面的错误码所代表的具体信息)
 "data":{} // 具体的业务数据

错误码说明

错误代码 错误描述
1 系统错误
2 服务暂停
3 用户名不存在
4 登陆验证错误
5 当前访问模块未实现
-1 非法请求地址(地址不存在)
-2 非法请求参数(参数可能包含非法字符)

登陆接口

请求地址：http://192.168.1.5/tch/api/login
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
username true string 用户名或者email
authcode true string 密码经过md5加密后的字符串

返回结果：JSON格式 

{
    "result":0,         
    "data":{}// 用户信息
}

登出接口

请求地址：http://192.168.1.5/tch/api/logout
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
username true string 用户名或者email

返回结果：JSON格式 

{
    "result":0
}

密码修改接口

请求地址：http://192.168.1.5/tch/api/updatepwd
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
username true string 用户名或者email
oldpwd true string md5加密的旧密码
newpwd true string md5加密的新密码

返回结果：JSON格式 

{
    "result":0
}

用户信息读取

请求地址：http://192.168.1.5/tch/api/getuser
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
uid true int 用户id

返回结果：JSON格式 

{
    "result":0,
    "data":{
        username, // 用户名
        realname, // 真是姓名
        age,   // 年龄
        birthyear, // 生日年份
        birthmonth, // 生日月份
        birthday, // 生日是哪天
        ....
    }
}

用户资料修改(还未完成)

请求地址：http://192.168.1.5/tch/api/updateuser
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
uid true int 用户id
type true string 分类('base'-->基本信息,'contact'-->联系方式,'edu'-->教育情况,'work'-->工作情况,'info'-->个人信息)
profile true array 针对type字段，相对应的信息

返回结果：JSON格式 

{
    "result":0
}

获取单条帖子信息

请求地址：http://192.168.1.5/tch/api/get_row_post
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
tid true string 帖子ID

返回结果：JSON格式,status=0表示操作成功 

{
    "result":0,
    "data":{
        id:'',// 帖子id
        clsid:'',// 所属班级id
        clsname:'',// 班级名称
        authorid:'',// 作者
        author:'',// 作者姓名
        useip:'',// 发帖者IP
        subject:'',  // 标题
        message:'', // 帖子内容
        dateline:'',  // 发表时间
        lastpost:'',  // 最后发表
        lastposter:'',// 最后发表人
        views:'',// 浏览次数
        replies:'',// 回复次数
        displayorder:'',// 显示顺序
        highlight:'',// 是否高亮
        digest:'',// 是否精华
    }
}

获取多条帖子信息

请求地址：http://192.168.1.5/tch/api/get_many_post
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
clsid false int 班级id
startid true int 起始id
number true int 获取多少条
order true string 排序字段(可以逗号分隔，如id asc,name desc)

返回结果：JSON格式,status=0表示操作成功 

{
    "result":0,
    "data"[{
        id:'',
        clsid:'',// 所属班级id
        clsname:'',// 班级名称
        authorid:'',// 作者
        author:'',// 作者姓名
        useip:'',// 发帖者IP
        subject:'',  // 标题
        message:'', // 帖子内容
        dateline:'',  // 发表时间
        lastpost:'',  // 最后发表
        lastposter:'',// 最后发表人
        views:'',// 浏览次数
        replies:'',// 回复次数
        displayorder:'',// 显示顺序
        highlight:'',// 是否高亮
        digest:'',// 是否精华
    },{},{}]
}

获取用户班级信息

请求地址：http://192.168.1.5/tch/api/get_user_class
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
uid false int 用户id

返回结果：JSON格式 

{
    "result":0,
    "data":[{
       clsid:'',// 班级id
       clsname:'',// 班级名称
       grade:'',// 所属年级
       areaname:'',// 所在城市区域
       schname:'',// 学校名称
       dateline:''// 班级创建时间
    },{}]
}

注册手机设备的uuid

请求地址：http://192.168.1.5/tch/api/register_device
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
deviceid true string 设备唯一id
pushtype true int 第三方push平台type(1:信鸽)
pushtoken true string 第三方push平台的token
type true string 设备类型
os true string os名称
osversion true string os版本
version true string 软件版本

返回结果：JSON格式 

{
    "result":0,
    "data":{
       uuid:''// 设备唯一id
    }
}

获取手机最新版本信息

请求地址：http://192.168.1.5/tch/api/getversion
请求方式：POST
返回结果：XML格式 

    <string>1.0</string>
取自“http://wiki.blueidea.com/index.php?title=手机api&oldid=9791”