接口通用信息
示例地址
http://....../app/getApp
接口控制器：
外网 http://110.110.1.20/app/
内网 http://192.168.1.22/app/
公共参数:
getApp接口名称
请求有以下两种方式
GET
POST
上传参数说明
UUID 设备号：
每个手机的设备号是唯一的
上传参数的格式
{"key":"value","key1":value1,"key2":"value2",..........}
返回的数据规范
a、明文返回值，直接使用
b、部分字段加密的返回值通过DES.decryptDES()解密，需要key和vi进行解密，
{
"code":1,
"msg":"xxxxxx",
"data":{}
}
返回数据说明
a、code 标识返回状态
1 成功
-1 失败
-101 token失效
b、msg 服务端返回的说明
c、data为空，返回 {}
返回示例
如：
{
"code":1,
"msg":"",
"data":{
"param1":"xxx",
"list":[
{
"aa":"xxx",
"bb":1,
"cc":"xxxxxx"
},
...........
]
}
}
如2：
{
"code":1,
"msg":"",
"data":{}
}
基础模块
获取访问令牌
请求地址
http://192.168.1.20/app/getAccessToken
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
uuid String 是 321234098546345634534526 设备号
响应参数
名称 类型 是否必须 示例值 描述
acccessToken String 是 访问令牌
expiresIn String 是 28800 过期时间, 单位为秒（可不做过期）
sessionKey String 是 78......610 session key(32位字符)
sessionSecret String 是 2222......0 session密钥(32位字符)
返回示例
{
"code":1,
"msg":"",
"data":{
"accessToken":"AVjWf49ZrHPXsqA1hwSr7AcheUIb/oaRTR
s0GzXxzsHBm79lcNLSNGjnisHaDBAWVM
R8tR0xMQjhIdwkve8eNTs=", //访问令牌
"expiresIn":28800, //Int, 过期时间, 单位为秒
"sessionKey":"787d9f9beeeca3379cde65ff3354e610", //session key
"sessionSecret":"222baa398b38a499f267ed869215b130" //session密钥
}
}
code取值
1成功
-1失败
账号模块
登录（4.10增加返回字段：classNum,grade）
请求地址
http://..../getLogin
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
stuNo String 是 SWE13001 学号
stuPsw String 是 2341 密码
响应参数
名称 类型 是否必须 示例值 描述
displayName String 是 张三 显示名称
authenUserId String 是 11.......fb 登录用户ID
headerUrl String 是 http://.x.png 头像
major String 是 软件工程 专业
stuNo String 是 SWE13001 学号
phone String 是 13600000001 联系电话
calssNum String 是 软件工程一班 班级
grade String 是 2013级 年级
返回示例
{
"code":1,
"msg":"登录成功",
"data":{
"displayName":"张三",
"headerUrl"："http://192.168.1.20/image/header.png"
"authenUserId":"1120d8d6ea4a4850b65d0faa40d6dffb
"major":"软件工程",
"stuNo"："SWE13001",
"phone":"13600000001",
"calssNum"："软件工程一班",
"phone":"2013级"
}
}
code取值
1成功
-1失败
获取用户头像(已弃用)
请求地址
http://..../getUserHeader
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
stuNo String 是 SWE13001 学号
响应参数
名称 类型 是否必须 示例值 描述
header String 是 http://xxx.jpg 头像地址
返回示例
{
"code":1,
"msg":"获取头像成功",
"data":{
"header":"http://xxx.jpg",
}
}
code取值
1成功
-1失败
注册（已弃用）
请求地址
http://..../register
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
stuNo String 是 SWE13001 学号（学号要唯一）
stuPsw String 是 2341 密码
data String 是 xxxx 二进制数据
name String 是 picture_0105 图片名称
响应参数
名称 类型 是否必须 示例值 描述
stuName String 是 张三 显示名称
authenUserId String 是 11.......fb 登录用户ID
headerUrl String 是 http://.x.png 头像
major String 是 软件工程 专业
stuNo String 是 SWE13001 学号
phone String 是 联系电话 13600000001
返回示例
{
"code":1,
"msg":"注册成功",
"data":{
"displayName":"张三",
"headerUrl"："http://192.168.1.20/image/header.png"
"authenUserId":"1120d8d6ea4a4850b65d0faa40d6dffb
"major":"软件工程",
"stuNo"："SWE13001"
"phone":"13600000001"
}
}
code取值
1成功
-1失败
主页
获取今日课程列表
请求地址
http://..../getTodayCourse(4.10 state 增加未签到状态)
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
响应参数
名称 类型 是否必须 示例值 描述
courseId String 是 sdfe12 课程Id
name String 是 软件工程 课程名称
date String 是 20170122 上课日期
state int 是 0 签到状态 0未开放签到 1正常
2旷课 3迟到 4请假 5.未签到
teacher String 是 顾萍萍 教师名称
classPlace String 是 主一110 上课地点
classTime int 是 0 节次 0一二节 1三四节 2午一午二
3五六节 4七八节 5 九十节
返回示例
{
"code":1,
"msg":"",
"data":{
"total":5,
"list":[
{
"courseId":"sdfe12",
"name":"软件工程",
"date":"20170122",
"state":0,
"teacher":顾萍萍,
"classPlace":"主一110",
"classTime" : 0
},
......
]
}
}
code取值
1成功
-1失败
签到
请求地址
http://..../signIn
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
courseId String 是 xxxx 课程Id
date String 是 20170328 日期
image String 否 xxxx 二进制数据
classTime int 是 节次 上课时间 0一二节 1三四节 2午一午二
3五六节 4七八节 5九十节
返回示例
{
"code":1,
"msg":"签到成功",
"data":{
}
}
code取值
1成功
-1失败
获取当前用户全部课程（可以查询每门课的考勤结果）
请求地址
http://..../getAllCourseList
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
响应参数
名称 类型 是否必须 示例值 描述
courseId String 是 sdfe12 课程Id
name String 是 软件工程 课程名称
teacher String 是 顾萍萍 任课教师名称
返回示例
{
"code":1,
"msg":"获取课程列表成功",
"data":{
"total":5,
"list":[
{
"courseId":"sdfe12",
"name":"软件工程",
"teacher":"任课教师名称",
},
......
]
}
}
code取值
1成功
-1失败
考勤结果查询(4.10 state 增加未签到状态)
请求地址
http://..../checkResult
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
startTime String 是 20170222 起始时间
endTime String 是 20170222 结束时间
courseId String 否 “sd11002” 课程Id(为空代表查询全部课程)
响应参数
名称 类型 是否必须 示例值 描述
courseId String 是 sdfe12 课程Id
name String 是 软件工程 课程名称
date String 是 20170122 上课日期
state int 是 0 签到状态 0未开放签到 1正常
2旷课 3迟到 4请假 5未签到
teacher String 是 顾萍萍 教师名称
classPlace String 是 主一110 上课地点
classTime int 是 0 节次 0一二节 1三四节 2午一午二
3五六节 4七八节 5 九十节
返回示例
{
"code":1,
"msg":"获取考勤结果成功",
"data":{
"total":5,
"list":[
{
"courseId":"sdfe12",
"name":"软件工程",
"date":"20170122",
"state":0,
"teacher":顾萍萍,
"classPlace":"主一110",
"classTime" : 0
},
......
]
}
}
code取值
1成功
-1失败
考勤结果列表(4.10 state 增加未签到状态)
请求地址
http://..../checkTruant
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
响应参数
名称 类型 是否必须 示例值 描述
courseId String 是 sdfe12 课程Id
name String 是 软件工程 课程名称
date String 是 20170122 上课日期
state int 是 0 签到状态 0未开放签到 1正常
2旷课 3迟到 4请假 5.未签到
teacher String 是 顾萍萍 教师名称
classPlace String 是 主一110 上课地点
classTime int 是 0 节次 0一二节 1三四节 2午一午二
3五六节 4七八节 5 九十节
返回示例
{
"code":1,
"msg":"获取考勤结果成功",
"data":{
"total":5,
"list":[
{
"courseId":"sdfe12",
"name":"软件工程",
"date":"20170122",
"state":0,
"teacher":顾萍萍,
"classPlace":"主一110",
"classTime" : 0
},
......
]
}
}
code取值
1成功
-1失败
获取本周课程列表
请求地址
http://..../getWeekCourse(4.10 state 增加未签到状态)
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
响应参数
名称 类型 是否必须 示例值 描述
courseId String 是 sdfe12 课程Id
name String 是 软件工程 课程名称
date String 是 20170122 上课日期
state int 是 0 签到状态 0未开放签到 1正常
2旷课 3迟到 4请假 5.未签到
teacher String 是 顾萍萍 教师名称
classPlace String 是 主一110 上课地点
classTime int 是 0 节次 0一二节 1三四节 2午一午二
3五六节 4七八节 5 九十节
返回示例
{
"code":1,
"msg":"",
"data":{
"total":5,
"list":[
{
"courseId":"sdfe12",
"name":"软件工程",
"date":"20170122",
"state":0,
"teacher":顾萍萍,
"classPlace":"主一110",
"classTime" : 0
},
......
]
}
}
code取值
1成功
-1失败
请假
请求地址
http://..../takeOff
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
courseId String 是 ddasd131 课程ID
date String 是 20170328 请假日期
classTime int 是 0 节次 0一二节 1三四节 2午一午二
3五六节 4七八节 5 九十节
data String 是 xxxx 二进制数据
name Sring 是 xxx.png 图片名称
reason String 是 想睡觉 请假理由
返回示例
{
"code":1,
"msg":"请假成功",
"data":{
}
}
code取值
1成功
-1失败
图片上传(4.10弃用)
请求地址
http://..../uploadPicture
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
data String 是 xxxx 二进制数据
name String 是 picture_0105 图片名称
type int 是 0 0头像
返回示例
{
"code":1,
"msg":"头像上传成功！",
"data":{
}
}
code取值
1成功
-1失败
用户密码修改（4.10新增）
请求地址
http://..../pswModify
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
oldpsw String 是 10086 旧密码
newpsw String 是 10087 新密码
返回示例
{
"code":1,
"msg":"密码修改成功！",
"data":{
}
}
code取值
1成功
-1失败
用户信息修改（4.10新增）
请求地址
http://..../userInfoModify
请求方式
POST
接口参数
名称 类型 是否必须 示例值 描述
authenUserId String 是 11...ffb 用户ID
phone String 是 10086 手机号码
返回示例
{
"code":1,
"msg":"修改成功！",
"data":{
}
}
code取值
1成功
-1失败
By Xiaolong,每一天都值得被认真对待！