关于使用规则,请注意:
关于接口文档,请注意:
目录 |
用户登录接口,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/*****
POST数据说明
POST数据示例如下:
{
"loginName":"",
"passWord":"",
loginType: ""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 当前登录用户名 |
| passWord | 是 | 当前登录用户密码 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
老师:
{
"error":0,
"mutilRoleList":
{
"userID":"10000001",
"empName":"teacher",
"gradeName":"一年级",
"deptName":"教务处",
"unitID":"10000006",
"unitName":"智慧动力",
"userType":"2",
"userTypeName":"老师",
"photoPath":"/HR_Employee10001/large.jpg"
},
{
"userID":"10000002",
"empName":"student",
"gradeName":"一年级",
"deptName":"101班",
"unitID":"10000006",
"unitName":"智慧动力",
"userType":"3",
"userTypeName":"学生",
"photoPath":"/HR_Employee10001/large.jpg"
}
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| data | dynamic | 用户信息 | |
| mutilRoleList | UserID | int | 用户ID |
| empName | string | 姓名 | |
| gradeName | string | 年级 | |
| deptName | string | 部门 | |
| unitID | string | 学校ID | |
| unitName | string | 学校名称 | |
| userTypeName | string | 用户类型 | |
| userType | int | 用户类型 | |
| photoPath | string | 头像 | |
用户登录接口,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/***
POST数据说明
POST数据示例如下:
{
loginName: '',
userID: "10008848",
passWord: '',
mobileMac: "",
clientModel: "iPhone SE",
appVersion:"1.2.1",
clientVersion: "10.3.1",
loginType: "1",
fatherLoginName: "13566593701",
deviceCode:"asdsadasdasdasdasdasd",
jsonString:"{
phoneName:"严浩的IPhone",
modelName :"iPhone SE",
systemName:"IOS",
systemVersion:"10.3.1"
}"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 当前登录用户名 |
| passWord | 是 | 当前登录用户密码 |
| userID | 是 | 用户ID (切换账户时使用,userID有值,使用userID,否则否则使用loginName+passWord 确保二者之一有值) |
| fatherLoginName | 是 | 父账户用户名 如果是多账户代理 此账户必填 否则不填 |
| mobileMac | 否 | 设备MAC |
| clientModel | 是 | 设备机型 |
| clientVersion | 是 | 设备版本 |
| jsonString | 是 | 用户信息JSON字符串 |
| loginType | 否 | 登录类型 Web = 0,IOS = 1,IOSPad = 2,Android = 3,AndroidPad = 4,IPTV = 5 |
| appVersion | 是 | app版本号 |
| deviceCode | 是 | 设备唯一编号,android传IMEI码,IOS使用uuid加keychain的方式,keychain中获取不到时就生成新的uuid并保存到keychain中 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
老师:
{
"error":0,
"user":
{
"userID":"1",
"userName":"admin",
"password":"123456"
"userType":2,
"sex":1,
"empID":"20000472",
"empCode":null,
"empName":"i老师助手",
"depName":null,
"mobile":"13586500193",
"loginLastTime":null,
"gradeName":null,
"isAppFamilyDetailShow":0,
"edunitID":"1",
"edunitName":null,
"unitLogo":"/addimg.png",
"email":"",
"cornet":"10000018",
"homeAddress":"浙江省宁波市",
"photoPath":"/Upload/avatars/HR_Employee1/medium.jpg",
"photoLarge":"/Upload/avatars/HR_Employee1/large.jpg",
"photoSmall":"/Upload/avatars/HR_Employee1/small.jpg",
"workTimeRemind":1
"sysRemind":1
"amNoRemindStart":"8:00",
"amNoRemindEnd":"11:30",
"pmNoRemindStart":"14:00",
"pmNoRemindEnd":"15:30",
"nodisturb":"1",
"nodisturbStart":"8:00",
"nodisturbEnd":"11:30",
"smsEndDate":"2017-08-09",
"birthday":"1992-08-09",
"marriage":0,
"educationLevel":"研究生",
"nation":"汉族",
"adUrl":"/addimg.png",
"about":"/About.html",
"helper":"/Api/Help.html",
"token":"df7a8fasdf6a7sdfa7s6f7",
"muneList":[{
"menuName":"网站",
"menuUrl":""
},
{
"menuName":"校信",
"menuUrl":""
},
{
"menuName":"作业",
"menuUrl":""
}],
"faUserInfo":{
"userID":"10000001",
"relation":"父子",
"password":"123456"
"userName":"13566593701",
"mobile":"13586500193",
"employeeID":"10000001",
"empName":"管理员",
"photoPath":"/Upload/avatars/10000001/medium.jpg",
"userType":"2",
"userTypeName":"教师"
}
"classes":[
"104",
"105"
]
}
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| data | dynamic | 用户信息 | |
| uerID | int | 用户ID | |
| userName | string | 用户名 | |
| dataUrl | string | 数据服务地址 | |
| password | string | 密码 | |
| userType | int | 用户类型 | |
| isAppFamilyDetailShow | int | 是否显示家庭详细信息(地址、电话),0否,1是 | |
| sex | int | 性别 | |
| empID | int | 人事ID | |
| marriage | int | 婚姻状态,0未婚,1已婚,2保密 | |
| birthday | string | 生日 | |
| nation | string | 民族 | |
| educationLevel | string | 学历 | |
| empCode | string | 人事编号 | |
| empName | string | 姓名 | |
| depName | string | 部门名称 | |
| mobile | string | 手机 | |
| gradeName | string | 年级(老师则没) | |
| edunitID | int | 学校ID | |
| edunitName | string | 学校名称 | |
| unitLogo | string | 学校logo | |
| string | |||
| cornet | string | 头像地址 | |
| homeAddress | string | 家庭住址 | |
| photoPath | string | 头像地址 | |
| photoLarge | string | 头像地址 | |
| photoSmall | string | 头像地址 | |
| workTimeRemind | int | 上课是否提醒(0否1是) | |
| sysRemind | int | 是否开启小助手提醒,0否1是 | |
| amNoRemindStart | string | 上午课程开始 | |
| amNoRemindEnd | string | 上午课程结束 | |
| pmNoRemindStart | string | 下午课程开始 | |
| pmNoRemindEnd | string | 下午课程结束 | |
| nodisturb | string | 免打扰(0否1是) | |
| nodisturbStart | int | 勿扰开始时间 | |
| nodisturbEnd | int | 勿扰结束时间 | |
| smsEndDate | string | 短信付费结束日期 | |
| adUrl | string | 广告地址 有就播放 否则就去除 | |
| about | string | 关于说明 | |
| helper | string | 帮助 | |
| token | string | 令牌 | |
| muneList | menuName | string | 菜单名 |
| menuUrl | string | 菜单url 为空表示采用原生地址 | |
| faUserInfo | userID | string | 用户ID |
| employeeID | string | 人员ID | |
| userName | string | 用户名= LoginName | |
| mobile | string | 手机 | |
| relation | string | 与关系 | |
| empName | string | 姓名 | |
| photoPath | string | 头像地址 | |
| userType | string | 用户类型 | |
| userTypeName | string | 用户类型名字 | |
| classes | string | 任课班级 | |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/******
POST数据说明
POST数据示例如下:
{
loginName: "1",
passWord: "123456",
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 用户名 |
| passWord | 是 | 新密码 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
获取验证码接口,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginSys/******
GET数据说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| phone | 是 | 手机账户 |
| type | 是 | 类型0 忘记密码 1 修改账户 2重置账号 |
GET数据示例如下:
{
"phone":"13564589685",
"type":"1"
}
返回字段说明
{
"error":0,
"verificationCode":"4521"
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 |
| message | string | 'error=1'时错误信息有值返回 |
| verificationCode | string | 验证码 |
验证验证码接口,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginSys/*****
GET数据说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| phone | 是 | 手机账户 |
| verCode | 是 | 验证码 |
GET数据示例如下:
{
"phone":"13564589685"
"varCode":"4582"
}
返回字段说明
{
"error":0
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 |
| message | string | 'error=1'时错误信息有值返回 |
验证Token,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/****
POST数据说明
POST数据示例如下:
{
"token":"tSiw3CkiVzcfR8klQ9eRaO4t+hsAQemn0Kt39f6mzhgEr4bmp+1dqMt0I+WapO/51lgDQRVaW8Styzh5KfPT4urvXl5gXIWIu8iL1f4hmK8YgLKHvKFmhu2vT6X5PKgzwuEdoUbNm2qtCai90waM5oHnRi0hfE1WWFReQvyq/15YhSXLp71m0WRANzregR8A5ez7eBTly51FwhgvVAG1CA==",
"userID":"10008817",
"unitID":"10000006",
"employeeID":"10000239",
"loginName":"13566593701",
"empName":"陈张生",
"loginType":"Android"
"appState": 0,
"appVersion":"1.1.7",
clientModel: "iPhone SE",
appVersion:"1.2.1",
clientVersion: "10.3.1",
deviceCode:"asdsadasdasdasdasdasd",
jsonString:"{
phoneName:"严浩的IPhone",
modelName :"iPhone SE",
systemName:"IOS",
systemVersion:"10.3.1"
}"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| token | 是 | 当前token |
| unitID | 是 | 单位ID |
| userID | 是 | 用户ID |
| employeeID | 是 | 人员ID |
| loginName | 是 | 用户名 |
| empName | 是 | 姓名 |
| loginType | 是 | Android、AndroidPad、IOS、IOSPad |
| fatherID | 否 | 父账号id |
| appState | 是 | app状态,0杀死后重新启动,1激活 |
| appVersion | 是 | app版本 |
| clientModel | 是 | 设备机型 |
| clientVersion | 是 | 设备版本 |
| jsonString | 是 | 用户信息JSON字符串 |
| deviceCode | 是 | 设备唯一编号,android传IMEI码,IOS使用uuid加keychain的方式,keychain中获取不到时就生成新的uuid并保存到keychain中 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":1,
"token":"tSiw3CkiVzcfR8klQ9eRaO4t+hsAQemn0Kt39f6mzhgEr4bmp+1dqMt0I+WapO/51lgDQRVaW8Styzh5KfPT4urvXl5gXIWIu8iL1f4hmK8YgLKHvKFmhu2vT6X5PKgzwuEdoUbNm2qtCai90waM5oHnRi0hfE1WWFReQvyq/15YhSXLp71m0WRANzregR8A5ez7eBTly51FwhgvVAG1CA=="
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error=2' 说明用户不存在或父账户不存在,'error=1' 接口错误 | |
| token | string | 为空说明token当前token有效,不为空说明token失效已重新生成token返回 | |
| userInfo | userID | string | 用户ID |
| userName | string | 登录名 | |
| password | string | 密码 | |
| passwordEncryp | string | 加密的密码 | |
| userType | int | 用户类型 | |
| empID | string | ID | |
| empName | string | 名称 | |
| depID | string | 部门ID | |
| depName | string | 部门名称 | |
| gradeName | string | 班级名称 | |
| edunitID | string | 单位ID | |
| edunitName | string | 单位名称 | |
| photoPath | string | 头像 | |
| photoLarge | string | 头像 | |
| photoSmall | string | 头像 | |
获取新token,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginSys/****
GET数据说明
GET数据示例如下:
{
"loginName":"13566593701",
"password":"",
"userID":"10008817",
"childUserID":"10008848"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 登录账号 |
| password | 是 | 密码 |
| userID | 是 | 用户id |
| childUserID | 是 | 子用户id |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"token":"tSiw3CkiVzcfR8klQ9eRaO4t+hsAQemn0Kt39f6mzhgEr4bmp+1dqMt0I+WapO/51lgDQRVaW8Styzh5KfPT4urvXl5gXIWIu8iL1f4hmK8YgLKHvKFmhu2vT6X5PKgzwuEdoUbNm2qtCai90waM5oHnRi0hfE1WWFReQvyq/15YhSXLp71m0WRANzregR8A5ez7eBTly51FwhgvVAG1CA=="
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 0 表示获取新token成功,2 获取失败,1 接口错误 | |
| message | string | 'error=1或2'时错误信息有值返回 | |
| token | string | 新token | |
验证验证码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/**
POST数据说明
POST数据示例如下:
{
loginName: "13566593701",
verificationCode: "123456",
unitCode:"zdy"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 登录名 |
| verificationCode | 是 | 验证码 |
| unitCode | 是 | 单位码 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
| password | string | 密码 | |
查询班级数据,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/****
POST数据说明
POST数据示例如下:
{
unitID: "10000006"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 学校ID |
返回字段说明
成功:
{
"error":0,
"data":[
{
"classBaseID":"10000108",
"className":"二年级2班",
"gradeBaseID":"10000001",
"gradeName":"二年级"
}
]
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
| data | classBaseID | string | 班级ID | ||
| gradeBaseID | string | 年级ID | |||
| gradeName | string | 年级名称 | |||
| className | string | 班级名称 | |||
验证号码是否是班主任号码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/***
POST数据说明
POST数据示例如下:
{
mobile: "13566593701"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| mobile | 是 | 班主任手机号 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
| data | teacherID | string | 教师ID | ||
验证身份,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/*****
POST数据说明
POST数据示例如下:
学生班主任号码验证
{
type:0,
teacherID: "10000239",
studentName:"陈海诺"
}
学生班级信息验证
{
type:1,
classBaseID: "10000001",
studentName:"陈海诺"
}
老师信息验证
{
type:2,
unitID: "10000006",
empName:"陈张生"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| type | 是 | 验证类型,0班主任电话验证,1学生信息验证,2教师信息验证 |
| teacherID | 否 | 班主任ID,type=0时必填 |
| classBaseID | 否 | 班级ID,type=1时必填 |
| studentName | 否 | 孩子姓名,type=0或type=1时必填 |
| unitID | 否 | 学校ID,type=2时必填 |
| empName | 否 | 教师姓名,type=2时必填 |
返回字段说明
学生
{
"error":0,
"data":[
{
"userID":"10129580",
"empName":"陈雅诺",
"className":"二年级1班",
"gender":"女",
"code":""
}
]
}
老师
{
"error":0,
"data":[
{
"userID":"10008817",
"empName":"陈张生",
"gender":"男",
"code":""
}
]
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
| data | userID | string | 用户ID | ||
| empName | string | 姓名 | |||
| className | string | 班级名称 | |||
| gender | string | 性别 | |||
| code | string | 身份证号 | |||
重置账号,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginSys/***
POST数据说明
POST数据示例如下:
学生
{
userID: "10129580",
empName:"陈张生15",
relationTypeName:"爸爸",
relationTypeID:"10001442",
mobile:"13566593701",
password:"",
type:0
}
老师
{
userID: "10129580",
mobile:"13566593701",
password:"",
type:1
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 孩子或老师用户ID |
| empName | 否 | 家长姓名,type=0时必填 |
| relationTypeName | 否 | 代理关系名称,type=0时必填 |
| relationTypeID | 否 | 代理关系ID,type=0时必填 |
| mobile | 是 | 手机号 |
| password | 是 | 密码 |
返回字段说明
成功:
{
"error":0,
"data":
{
"loginName":"13566593701",
"passWord":""
}
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
| data | loginName | string | 账号 | ||
| passWord | string | 密码 | |||
获取所有学校,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginSys/*****
POST数据说明
POST数据示例如下:
{
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|
返回字段说明
成功:
{
"error":0,
"data":[
{
"unitID":"10000006",
"unitName":"二年级2班"
}
]
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
| data | unitID | string | 学校ID | ||
| unitName | string | 学校名称 | |||
获取客服信息,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginSys/*****
GET数据说明
GET数据示例如下:
{
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|
返回字段说明
成功:
{
"error":0,
"data":[
{
"qq":"2077174391",
"qqType":1,
"mobile":"4006069103",
}
]
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
| data | string | 客服QQ | |||
| qqType | type | qq号类型 | |||
| mobile | type | 客服电话 | |||
获取App登录欢迎页图片,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginSys/*****
GET数据说明
GET数据示例如下:
参数说明
| 参数 | 是否必须 | 说明 |
|---|
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":[
{
"userType":2,
"versionCode":"12321312312",
"photos":[
"http://oss.zjzdy.net/APP/welcome.jpg",
"http://oss.zjzdy.net/APP/welcome.jpg"
]
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示token有效 | |||
| message | string | 'error=1' token过期,返回新token | |||
| data | userType | int | 用户类型 | ||
| versionCode | string | 版本编号 | |||
| photos | string数组 | 图片路径数组 | |||