“手机api”的版本间的差异

来自Blueidea
跳转至： 导航、 搜索
（→‎手机邀请码发送接口）
 
（未显示同一用户的60个中间版本）
第1行： 第1行：
−
'''返回格式说明'''
+
'''全局result错误码说明'''
−
<source lang="javascript">
+
−
"result":0,// (0:表示成功,负数表示传入参数有错，正数表示服务器执行出现错误,参见下面的错误码所代表的具体信息)
+
−
"data":{} // 具体的业务数据
+
−
</source>
+
−
'''错误码说明'''
+
 
:{| class="wikitable" style="font-size:13px;"
 
:{| class="wikitable" style="font-size:13px;"
 
!错误代码
 
!错误代码
 
!错误描述
 
!错误描述
 
|-
 
|-
−
| 1||系统错误
+
| 0||表示请求成功
 +
|-
 +
| -101||系统错误
 
|-  
 
|-  
−
| 2||服务暂停
+
| -102||服务暂停
 
|-  
 
|-  
−
| 3||用户名不存在
+
| -103||必须传递的参数不存在或者不正确
 
|-  
 
|-  
−
| 4||用户名或者密码验证错误
+
| -104||请求的api地址不存在
−
|-
+
−
| 5||当前访问模块未实现
+
−
|-
+
−
| 6||登陆token已经过期(token过期时间是三个月，每次登陆都会更新过期时间，除非未登陆时间超过三个月,手机客户端需要判断这个参数，然后再次输入登陆)
+
−
|-
+
−
| -1||非法请求地址(地址不存在)
+
−
|-
+
−
| -2||错误的请求参数(参数可能有非法字符、为空或者参数未传递)
+
 
|}
 
|}
 
== 登陆接口 ==
 
== 登陆接口 ==
第34行： 第23行：
 
! 类型及范围
 
! 类型及范围
 
! 说明
 
! 说明
 +
|-
 +
!scope="row"|devicetoken
 +
| true || string ||设备token(des加密),确定用户的设备是否有使用过
 
|-
 
|-
 
!scope="row"|username  
 
!scope="row"|username  
−
| true || string ||用户名或者email
+
| true || string ||des加密手机号码
 
|-
 
|-
 
!scope="row"|authcode  
 
!scope="row"|authcode  
−
| true || string || 密码经过md5加密后的字符串
+
| true || string || 密码经过des加密后的字符串
 
|}
 
|}
 
'''返回结果'''：JSON格式
 
'''返回结果'''：JSON格式
 +
:{| class="wikitable" style="font-size:13px;"
 +
! 参数名称
 +
! 类型及范围
 +
! 说明
 +
|-
 +
!scope="row"|result
 +
| int || '''-1:用户不存在，或者被删除;<br>-2:用户名或者密码不正确'''
 +
|-
 +
!scope="row"|data
 +
|array||  用户信息
 +
|}
 
<source lang="javascript">
 
<source lang="javascript">
 
{
 
{
第59行： 第62行：
 
! 说明
 
! 说明
 
|-
 
|-
−
!scope="row"|username
+
!scope="row"|mobile
−
| true || string ||用户名或者email
+
| true || string||用户手机号(des加密)
 
|}
 
|}
 
'''返回结果'''：JSON格式
 
'''返回结果'''：JSON格式
第66行： 第69行：
 
{
 
{
 
     "result":0
 
     "result":0
 +
}
 +
</source>
 +
 +
== 手机邀请码发送接口 ==
 +
'''请求地址'''：http://192.168.1.5/tch/api/sms_invite<br>
 +
'''请求方式'''：POST<br>
 +
'''请求参数'''：
 +
:{| class="wikitable" style="font-size:13px;"
 +
! 参数名称
 +
! 必选
 +
! 类型及范围
 +
! 说明
 +
|-
 +
!scope="row"|mobile
 +
| true || string || des加密后的手机号码
 +
|}
 +
'''返回结果'''：JSON格式
 +
:{| class="wikitable" style="font-size:13px;"
 +
! 参数名称
 +
! 类型及范围
 +
! 说明
 +
|-
 +
!scope="row"|result
 +
| int || '''-1:手机号码格式不正确;<br>-2：发送邀请短信失败<br>-3:手机号码已经被邀请注册<br>-4:未知的手机号，不能提供发邀请码的服务，重填.<br>-5:手机已经被列入黑名单列表，如需解除请联系客服QQ800003860或手机号码*****'''
 +
|-
 +
!scope="row"|data
 +
| array|| '''发送完成反馈信息'''
 +
|}
 +
<source lang="javascript">
 +
{
 +
    "result":0,       
 +
    "data":{
 +
        'attribution':'',// 手机归属地
 +
        'operators':'',// 手机运营商
 +
        'invitecode':'' // 生成的邀请码(经过加密处理)
 +
    }
 +
}
 +
</source>
 +
 +
== 获取家长的所有小孩和班级==
 +
'''请求地址'''：http://192.168.1.5/tch/api/getchilds<br>
 +
'''请求方式'''：POST<br>
 +
'''请求参数'''：
 +
:{| class="wikitable" style="font-size:13px;"
 +
! 参数名称
 +
! 必选
 +
! 类型及范围
 +
! 说明
 +
|-
 +
!scope="row"|username
 +
| true || string||家长用户手机号(des加密)
 +
|}
 +
'''返回结果'''：JSON格式
 +
<source lang="javascript">
 +
{
 +
    "result":0,
 +
    "data":{
 +
        // 所有小孩
 +
        "childs":[{
 +
            sid:0,// 学生id
 +
            cid:0,// 小孩所在班级id
 +
            relcode:"父亲",// 家长称呼，
 +
            studentname："",// 学生姓名
 +
        }], 
 +
        // 所有班级
 +
        "classes":[{
 +
            mastername:0,// 班主任名称
 +
            cid:0,// 班级id
 +
            cname:"",// 班级名称
 +
            schid："",// 学校id
 +
            schname："",// 学校名称
 +
        }] 
 +
    }
 
}
 
}
 
</source>
 
</source>
第80行： 第156行：
 
|-
 
|-
 
!scope="row"|username
 
!scope="row"|username
−
| true || string ||用户名或者email
+
| true || string ||des加密的手机号码
 
|-
 
|-
 
!scope="row"|oldpwd  
 
!scope="row"|oldpwd  
−
| true || string ||md5加密的旧密码
+
| true || string ||des加密的旧密码
 
|-
 
|-
 
!scope="row"|newpwd
 
!scope="row"|newpwd
−
| true || string ||md5加密的新密码
+
| true || string ||des加密的新密码
 
|}
 
|}
 
'''返回结果'''：JSON格式
 
'''返回结果'''：JSON格式
 +
:{| class="wikitable" style="font-size:13px;"
 +
! 参数名称
 +
! 类型及范围
 +
! 说明
 +
|-
 +
!scope="row"|result
 +
| int || '''0:更新成功<br>-1:没有做任何修改<br>-2:旧密码不正确<br>-3:用户不存在或者被删除'''
 +
|}
 
<source lang="javascript">
 
<source lang="javascript">
 
{
 
{
第124行： 第208行：
 
</source>
 
</source>
  
−
== 用户资料修改(还未完成) ==
+
== 获取单条帖子信息 ==
−
'''请求地址'''：http://192.168.1.5/tch/api/updateuser<br>
+
'''请求地址'''：http://192.168.1.5/tch/api/getthread<br>
 
'''请求方式'''：POST<br>
 
'''请求方式'''：POST<br>
 
'''请求参数'''：
 
'''请求参数'''：
第134行： 第218行：
 
! 说明
 
! 说明
 
|-
 
|-
−
!scope="row"|uid
+
!scope="row"|tid
−
| true || int||用户id
+
| true || int||主题id
−
|-
+
−
!scope="row"|type
+
−
| true || string||分类('base'-->基本信息,'contact'-->联系方式,'edu'-->教育情况,'work'-->工作情况,'info'-->个人信息)
+
−
|-
+
−
!scope="row"|profile
+
−
| true || array||针对type字段，相对应的信息
+
 
|}
 
|}
 
'''返回结果'''：JSON格式
 
'''返回结果'''：JSON格式
−
<source lang="javascript">
 
−
{
 
−
    "result":0
 
−
}
 
−
</source>
 
−
 
−
== 获取单条帖子信息 ==
 
−
'''请求地址'''：http://192.168.1.5/tch/api/get_row_post<br>
 
−
'''请求方式'''：POST<br>
 
−
'''请求参数'''：
 
 
:{| class="wikitable" style="font-size:13px;"
 
:{| class="wikitable" style="font-size:13px;"
 
! 参数名称
 
! 参数名称
−
! 必选
 
 
! 类型及范围
 
! 类型及范围
 
! 说明
 
! 说明
 
|-
 
|-
−
!scope="row"|tid
+
!scope="row"|result
−
| true || string||帖子ID
+
| int || '''0:更新成功<br>-1:帖子不存在或者被删除<br>-2:帖子已经关闭'''
 
|}
 
|}
−
'''返回结果'''：JSON格式,status=0表示操作成功
 
 
<source lang="javascript">
 
<source lang="javascript">
 
{
 
{
 
     "result":0,
 
     "result":0,
 
     "data":{
 
     "data":{
−
         id:'',// 帖子id
+
         tid:'',// 主题id
 
         clsid:'',// 所属班级id
 
         clsid:'',// 所属班级id
 
         clsname:'',// 班级名称
 
         clsname:'',// 班级名称
−
         authorid:'',// 作者
+
         authorid:'',// 作者id
−
         author:'',// 作者姓名
+
         author:'',// 作者用户名
−
        useip:'',// 发帖者IP
+
 
         subject:'',  // 标题
 
         subject:'',  // 标题
 
         message:'', // 帖子内容
 
         message:'', // 帖子内容
第179行： 第244行：
 
         lastpost:'',  // 最后发表
 
         lastpost:'',  // 最后发表
 
         lastposter:'',// 最后发表人
 
         lastposter:'',// 最后发表人
−
        views:'',// 浏览次数
 
−
        replies:'',// 回复次数
 
−
        displayorder:'',// 显示顺序
 
−
        highlight:'',// 是否高亮
 
−
        digest:'',// 是否精华
 
 
     }
 
     }
 
}
 
}
第270行： 第330行：
 
:{| class="wikitable" style="font-size:13px;"
 
:{| class="wikitable" style="font-size:13px;"
 
! 参数名称
 
! 参数名称
−
!
+
! 必选
 +
! 类型及范围
 +
! 说明
 +
|-
 +
!scope="row"|devicetoken
 +
| true|| string||设备的token(des加密)
 +
|-
 +
!scope="row"|type
 +
| true|| string||设备的类型(1:IOS,2:Android)
 +
|-
 +
!scope="row"|pushtype
 +
| true|| int|| 推送平台的类型(1:信鸽,2:极光)
 +
|-
 +
!scope="row"|pushtoken
 +
| true|| string|| 推送平台的token(des加密)
 +
|-
 +
!scope="row"|os
 +
| true|| string|| 手机OS
 +
|-
 +
!scope="row"|osversion
 +
| true|| string|| 手机OS版版本
 +
|}
 +
'''返回结果'''：JSON格式
 +
<source lang="javascript">
 +
{
 +
    "result":0
 +
}
 +
</source>

2014-08-30T17:29:29的最后版本

全局result错误码说明

错误代码 错误描述
0 表示请求成功
-101 系统错误
-102 服务暂停
-103 必须传递的参数不存在或者不正确
-104 请求的api地址不存在

登陆接口

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

参数名称 必选 类型及范围 说明
devicetoken true string 设备token(des加密),确定用户的设备是否有使用过
username true string des加密手机号码
authcode true string 密码经过des加密后的字符串

返回结果：JSON格式

参数名称 类型及范围 说明
result int -1:用户不存在，或者被删除;
-2:用户名或者密码不正确
data array 用户信息 
{
    "result":0,         
    "data":{}// 用户信息
}

登出接口

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

参数名称 必选 类型及范围 说明
mobile true string 用户手机号(des加密)

返回结果：JSON格式 

{
    "result":0
}

手机邀请码发送接口

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

参数名称 必选 类型及范围 说明
mobile true string des加密后的手机号码

返回结果：JSON格式

参数名称 类型及范围 说明
result int -1:手机号码格式不正确;
-2：发送邀请短信失败
-3:手机号码已经被邀请注册
-4:未知的手机号，不能提供发邀请码的服务，重填.
-5:手机已经被列入黑名单列表，如需解除请联系客服QQ800003860或手机号码*****
data array 发送完成反馈信息 
{
    "result":0,         
    "data":{
        'attribution':'',// 手机归属地
        'operators':'',// 手机运营商
        'invitecode':'' // 生成的邀请码(经过加密处理)
    }
}

获取家长的所有小孩和班级

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

参数名称 必选 类型及范围 说明
username true string 家长用户手机号(des加密)

返回结果：JSON格式 

{
    "result":0,
    "data":{
        // 所有小孩
        "childs":[{
            sid:0,// 学生id
            cid:0,// 小孩所在班级id
            relcode:"父亲",// 家长称呼，
            studentname："",// 学生姓名
         }],  
        // 所有班级
        "classes":[{
            mastername:0,// 班主任名称
            cid:0,// 班级id
            cname:"",// 班级名称
            schid："",// 学校id
            schname："",// 学校名称
         }]  
    }
}

密码修改接口

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

参数名称 必选 类型及范围 说明
username true string des加密的手机号码
oldpwd true string des加密的旧密码
newpwd true string des加密的新密码

返回结果：JSON格式

参数名称 类型及范围 说明
result int 0:更新成功
-1:没有做任何修改
-2:旧密码不正确
-3:用户不存在或者被删除 
{
    "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/getthread
请求方式：POST
请求参数：

参数名称 必选 类型及范围 说明
tid true int 主题id

返回结果：JSON格式

参数名称 类型及范围 说明
result int 0:更新成功
-1:帖子不存在或者被删除
-2:帖子已经关闭 
{
    "result":0,
    "data":{
        tid:'',// 主题id
        clsid:'',// 所属班级id
        clsname:'',// 班级名称
        authorid:'',// 作者id
        author:'',// 作者用户名
        subject:'',  // 标题
        message:'', // 帖子内容
        dateline:'',  // 发表时间
        lastpost:'',  // 最后发表
        lastposter:'',// 最后发表人
    }
}

获取多条帖子信息

请求地址：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
请求参数：

参数名称 必选 类型及范围 说明
devicetoken true string 设备的token(des加密)
type true string 设备的类型(1:IOS,2:Android)
pushtype true int 推送平台的类型(1:信鸽,2:极光)
pushtoken true string 推送平台的token(des加密)
os true string 手机OS
osversion true string 手机OS版版本

返回结果：JSON格式 

{
    "result":0
}
取自“http://wiki.blueidea.com/index.php?title=手机api&oldid=9871”