关于使用规则,请注意:
关于接口文档,请注意:
验证Token,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
"token":"tSiw3CkiVzcfR8klQ9eRaO4t+hsAQemn0Kt39f6mzhgEr4bmp+1dqMt0I+WapO/51lgDQRVaW8Styzh5KfPT4urvXl5gXIWIu8iL1f4hmK8YgLKHvKFmhu2vT6X5PKgzwuEdoUbNm2qtCai90waM5oHnRi0hfE1WWFReQvyq/15YhSXLp71m0WRANzregR8A5ez7eBTly51FwhgvVAG1CA==",
"userID":"",
"unitID":"",
"employeeID":"10000239",
"loginName":"",
"empName":"陈张生",
"loginType":"Android"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| token | 是 | 当前token |
| unitID | 是 | 单位ID |
| userID | 是 | 用户ID |
| employeeID | 是 | 人员ID |
| loginName | 是 | 用户名 |
| empName | 是 | 姓名 |
| loginType | 是 | Android、AndroidPad、IOS、IOSPad |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":1,
"token":"tSiw3CkiVzcfR8klQ9eRaO4t+hsAQemn0Kt39f6mzhgEr4bmp+1dqMt0I+WapO/51lgDQRVaW8Styzh5KfPT4urvXl5gXIWIu8iL1f4hmK8YgLKHvKFmhu2vT6X5PKgzwuEdoUbNm2qtCai90waM5oHnRi0hfE1WWFReQvyq/15YhSXLp71m0WRANzregR8A5ez7eBTly51FwhgvVAG1CA=="
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示token有效 | |
| message | string | 'error=1' token过期,返回新token | |
| message | string | 'error=2' 接口异常 | |
用户二维码登录接口,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
"userID":"",
"loginCode":"0d21156f57254a0eb0b91fd88ed4696c",
"phoneType":"0"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| phoneType | 是 | 当前类型 "0"苹果端,"1"安卓端,"2"微信端 |
| loginCode | 是 | 登录唯一标识符 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
用户登录接口,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/***
POST数据说明
POST数据示例如下:
{
"userID":"",
"userType":"123456",
"unitID":"123456"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| userType | 是 | 当前类型 |
| unitID | 是 | 学校ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"isShowPaySms":0,
"oneCardData":{
isShowOneCard:1,
oneCardState:1,
endDate:""
},
"data":[
{
"openType":0
"fullName":"活动",
"iconPath":"http://demo.zjzdy.net//Css/ico/active.png",
"url":"http://demo.zjzdy.net//Views/MobilePage/index.html"
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| isShowPaySms | int | 是否显示短信付费项:'0'表示不显示,'1'表示显示 | |||
| oneCardData | isShowOneCard | int | 是否显示一卡通菜单,0否1是 | ||
| oneCardState | int | 一卡通状态,0未绑定,1已绑定未开通,2已绑定并且已开通 | |||
| endDate | string | 到期时间 | |||
| data | openType | int | 0打开网页 1打开APP内界面 2打开APP | ||
| fullName | string | 名称 | |||
| iconPath | string | 图片地址 | |||
| url | string | url | |||
用户登录接口,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
"loginName":"15906512352",
"passWord":"8888888",
loginType: ""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 当前登录用户名 |
| passWord | 是 | 当前登录用户密码 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
老师:
{
"error":0,
"mutilRoleList":
{
"userID":"",
"empName":"teacher",
"gradeName":"一年级",
"deptName":"教务处",
"unitName":"智慧动力",
"userType":"2",
"userTypeName":"老师",
"photoPath":"/HR_Employee10001/large.jpg"
},
{
"userID":"",
"empName":"student",
"gradeName":"一年级",
"deptName":"101班",
"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 | 部门 | |
| unitName | string | 学校名称 | |
| userTypeName | string | 用户类型 | |
| userType | int | 用户类型 | |
| photoPath | string | 头像 | |
用户登录接口,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/***
POST数据说明
POST数据示例如下:
{
loginName: '',
userID: "",
passWord: '',
mobileMac: "",
clientModel: "",
clientVersion: "",
loginType: "2",
fatherLoginName:""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 当前登录用户名 |
| passWord | 是 | 当前登录用户密码 |
| userID | 是 | 用户ID (切换账户时使用,userID有值,使用userID,否则否则使用loginName+passWord 确保二者之一有值) |
| fatherLoginName | 是 | 父账户用户名 如果是多账户代理 此账户必填 否则不填 |
| mobileMac | 否 | 设备MAC |
| clientModel | 否 | 设备机型: 0:IPTV, 1:Web, 2:IOS, 3:Android,4:Android Pad,5:IOS Pad |
| clientVersion | 否 | 设备版本 |
| loginType | 否 | 登录类型 Web = 0,IOS = 1,IOSPad = 2,Android = 3,AndroidPad = 4,IPTV = 5 |
| appVersion | 是 | app版本号 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
老师:
{
"error":0,
"user":
{
"userID":"",
"userName":"",
"password":""
"userType":2,
"sex":1,
"empID":"",
"empCode":null,
"empName":"i老师助手",
"depName":null,
"mobile":"",
"loginLastTime":null,
"gradeName":null,
"edunitID":"1",
"edunitName":null,
"unitLogo":"/Model/addimg.png",
"email":"",
"cornet":"",
"homeAddress":"浙江省宁波市",
"photoPath":"/Upload/avatars/HR_Employee1/medium.jpg",
"photoLarge":"/Upload/avatars/HR_Employee1/large.jpg",
"photoSmall":"/Upload/avatars/HR_Employee1/small.jpg",
"workTimeRemind":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",
"adUrl":"/Model/addimg.png",
"about":"/Api/About.html",
"helper":"/Api/Help.html",
"token":"df7a8fasdf6a7sdfa7s6f7",
"muneList":[{
"menuName":"网站",
"menuUrl":""
},
{
"menuName":"校信",
"menuUrl":""
},
{
"menuName":"作业",
"menuUrl":""
}],
"faUserInfo":{
"userID":"",
"relation":"父子",
"password":""
"userName":"",
"mobile":"",
"employeeID":"",
"empName":"管理员",
"photoPath":"/Upload/avatars//medium.jpg",
"userType":"2",
"userTypeName":"教师"
}
"classes":[
"104",
"105"
]
}
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| data | dynamic | 用户信息 | |
| uerID | int | 用户ID | |
| userName | string | 用户名 | |
| password | string | 密码 | |
| userType | int | 用户类型 | |
| sex | int | 性别 | |
| empID | int | 人事ID | |
| 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是) | |
| 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/ApiLoginApi/******
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| 否 | email(老师) | |
| cornet | 否 | 短号(老师) |
| sex | 否 | 性别(0 女 1男) |
| photoPath | 否 | 头像(字符流) |
| address | 否 | 地址(学生) |
| empName | 否 | 姓名 |
| md5code | 否 | 头像MD5 |
| fileName | 否 | 头像图片名称 |
| customFileName | 否 | 头像图片名称 |
| fileFormat | 否 | 头像图片格式 |
| fileSize | 否 | 头像图片大小 |
| birthday | 否 | 生日,格式:yyyy-MM-dd |
| marriage | 否 | 婚姻状态,0未婚,1已婚,2保密 |
| nationID | 否 | 民族id |
| educationLevelID | 否 | 学历ID |
POST数据示例如下:
{
userID:""
email: "13566793341@qq.com",
cornet: "6652",
mobile: "",
sex: "1",
photoPath: "dfgsdfasdgsfgfhgfhg",
address: "宁波高新区世纪大道",
empName: "陈张生",
md5code:"12312",
fileName:"123",
customFileName :"123",
fileFormat:".JPG",
fileSize:"20"
}
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
| photoSmall | string | 头像 | |
| photoLarge | string | 头像 | |
删除记忆,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
userID: '1',
employeeID: '1',
unitID: '1'
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| employeeID | 是 | 人员ID |
| unitID | 是 | 组织ID |
| token | 是 | token |
返回字段说明
成功:
{
"error":0,
"groupList":[
{
"groupId":"1",
"groupName":"同事",
"groupUserCount":"12",
"userList":[
{
"userID":"10",
"groupId":"1",
"userType":"2",
"isAppFamilyDetailShow":0,
"employeeName":"王老师",
"userPhoto":"/Website/Content/logo.jpg",
"mobile":"",
"conner":"661",
"post":"班主任",
"genderName":"男",
"departName":"101班",
"guardian":"山爸爸",
"relationship":"父子",
"email":"661@qq.con",
"addres":"宁波高新区彩虹大道211号"
}
]
}
]
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| menuname | string | 菜单名称 | |
| groupName | groupId | int | 用户ID |
| groupName | string | 姓名 | |
| groupUserCount | string | 学校名称 | |
| userList | userID | string | userID |
| groupId | string | groupId | |
| employeeName | string | 姓名 | |
| userType | string | 类型 2 老师 3 学生 | |
| isAppFamilyDetailShow | int | 是否显示家庭详细信息(地址、电话),0否,1是 | |
| userPhoto | string | 头像 | |
| mobile | string | 手机 | |
| conner | string | 短号 | |
| post | string | 职务 | |
| genderName | string | 性别 | |
| departName | string | 部门(班级) | |
| guardian | string | 监护人(教师为空) | |
| relationship | string | 监护人关系(教师为空) | |
| string | 邮箱(学生为空) | ||
| addres | string | 家庭地址 | |
获取通讯录(分级加载),具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/******
POST数据说明
POST数据示例如下:
{
userID: '',
type:"dep",
id:"10000035"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| type | 否 | 组类型 |
| id | 否 | 组ID |
返回字段说明
成功:
{
"error":0,
"data":{
"groups":[{
"id":"123123",
"groupName":"asdasd",
"userCount":"12",
"groupType":"Dep",
"typeName":"部门"
}],
"userList":[
{
"userID":"10",
"userType":"2",
"isAppFamilyDetailShow":0,
"employeeName":"王老师",
"userPhoto":"/Content/logo.jpg",
"mobile":"",
"conner":"661",
"genderName":"男",
"departName":"101班",
"guardian":"山爸爸",
"relationship":"父子",
"email":"661@qq.con",
"addres":"宁波高新区彩虹大道211号"
}
]
}
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1时错误信息 | |||
| groups | id | string | 组ID | ||
| groupName | string | 分组名称 | |||
| userCount | string | 分组用户 | |||
| groupType | string | 组类型 | |||
| typeName | string | 类型名称 | |||
| userList | userID | string | 用户ID | ||
| employeeName | string | 姓名 | |||
| userType | string | 类型1教育局 2 老师 3 学生 | |||
| isAppFamilyDetailShow | int | 是否显示家庭详细信息(地址、电话),0否,1是 | |||
| userPhoto | string | 头像 | |||
| mobile | string | 手机 | |||
| conner | string | 短号 | |||
| genderName | string | 性别 | |||
| departName | string | 部门(班级) | |||
| guardian | string | 监护人(教师为空) | |||
| relationship | string | 监护人关系(教师为空) | |||
| string | 邮箱(学生为空) | ||||
| addres | string | 家庭地址 | |||
获取验证码接口,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/****
GET数据说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| phone | 是 | 手机账户 |
| type | 是 | 类型0 忘记密码 1 修改账户 |
GET数据示例如下:
{
"phone":"13564589685",
"type":"1"
}
返回字段说明
{
"error":0,
"verificationCode":"4521"
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 |
| message | string | 'error=1'时错误信息有值返回 |
| verificationCode | string | 验证码 |
验证验证码接口,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| phone | 是 | 手机账户 |
| verCode | 是 | 验证码 |
GET数据示例如下:
{
"phone":"13564589685"
"varCode":"4582"
}
返回字段说明
{
"error":0
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 |
| message | string | 'error=1'时错误信息有值返回 |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
userID: "1",
passWord: "123456",
newPassWord: "123456"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| passWord | 是 | 老密码 |
| newPassWord | 是 | 新密码 |
| token | 是 | token |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
loginName: "1",
passWord: "123456",
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 用户名 |
| passWord | 是 | 新密码 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/******
POST数据说明
POST数据示例如下:
{
userID: "1",
newloginName: "123456",
verificationCode: "1256"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| newloginName | 是 | 新账户 |
| verificationCode | 是 | 验证码 |
| token | 是 | token |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
userID: "1",
mobile: "",
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| mobile | 是 | 新手机号码 |
| token | 是 | token |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/******
POST数据说明
POST数据示例如下:
{
userID: "1",
workTimeRemind: 1,
nodisturb: 1,
nodisturbStart: "9:30",
nodisturbEnd: "15:30",
sysRemind:0
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| workTimeRemind | 否 | 是否提醒(0否1是) |
| nodisturb | 否 | 是否提醒(0否1是) |
| nodisturbStart | 否 | nodisturb 设置 必填 |
| nodisturbEnd | 否 | nodisturb 设置 必填 |
| sysRemind | 否 | 是否开启小助手提醒(0否1是) |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
获取付费项目,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
unitID:"",
token:"SDE4fsdfs4"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 用户ID |
| token | 是 | token |
返回字段说明
成功:
{
"error":0,
"data":[
{
"itemName":"开通短信12个月",
"price":"98",
"months":"12"
},
{
"itemName":"开通短信3个月",
"price":"25",
"months":"3"
},
{
"itemName":"开通短信1个月",
"price":"10",
"months":"1"
}
]
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
| itemName | string | 项目 | |
| price | string | 价格 | |
| months | string | 月数 | |
支付,具体如下:
接口调用请求说明
http请求方式: Post
{WebPath}/api/ApiLoginApi/******
Post数据说明
Post数据示例如下:
{
channel: "alipay_wap"
, subject: "短信支付"
, body: "一年的短信费用"
, amount: 1
, userID: ""
, empName: "管理员"
, months: "3"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| channel | 是 | 支付使用的第三方支付渠道 |
| subject | 是 | 商品的标题 |
| body | 是 | 商品的描述 |
| amount | 是 | 订单总金额, 单位为对应币种的最小货币单位,例如:人民币为分(如订单总金额为 1 元,此处请填 100)。 |
| userID | 是 | 用户ID。 |
| empName | 是 | 姓名。 |
| months | 是 | 付款月数 |
返回字段说明
成功:
{
"error":0,
"charge":{
"id":"",
"object":"",
"created":,
"livemode":false,
"paid":false,
"refunded":false,
"app":"",
"channel":"",
"order_no":"",
"client_ip":"127.0.0.1",
"amount":1,
"amount_settle":1,
"currency":"cny",
"subject":"短信支付",
"body":"一年的短信费用",
"extra":{
"success_url":"",
"cancel_url":""
},
"time_paid":null,
"time_expire":1471062721,
"time_settle":null,
"transaction_no":null,
"refunds":{
"object":"list",
"url":"/v1/charges/ch_9Ka1a5Ta5yj9efHmjPrfvH08/refunds",
"has_more":false,
"data":[
]
},
"amount_refunded":0,
"failure_code":null,
"failure_msg":null,
"metadata":{
},
"credential":{
"object":"credential",
"alipay_wap":{
"channel_url":"",
"_input_charset":"utf-8",
"body":"一年的短信费用",
"it_b_pay":"2016-08-13 12:32:01",
"notify_url":"",
"out_trade_no":"",
"partner":"",
"payment_type":"1",
"return_url":"",
"seller_id":"",
"service":"",
"subject":"",
"total_fee":"0.01",
"sign":"",
"sign_type":"RSA"
}
},
"description":null
}
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
| itemName | string | 项目 | |
| price | string | 价格 | |
获取广告页地址,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
unitID: ""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 学校ID |
返回字段说明
成功:
{
"error":0,
"adUrl":"/Model/addimg.png"
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
| adUrl | string | 广告Url | |
获取广告页地址,具体如下:
接口调用请求说明
http请求方式: Post
{WebPath}/api/ApiLoginApi/*****
Post数据说明
Post数据示例如下:
{ userID: "",
empName: "",
unitID: "",
unitName: "",
fdContent: "test",
feedSource:1,
files: [{
fileName: "image1",
customFileName:"22222",
sortCode: 1,
fileFormat: ".jpg",
fileSize: "123",
timeLength: "100",
directoryPath: "medium20160629121905.jpg",
md5code:"12312312"
}]
}
参数说明
| 参数 | 是否必须 | 说明 | |
|---|---|---|---|
| userID | 是 | 用户ID | |
| empName | 是 | 用户ID | |
| unitID | 是 | 用户ID | |
| unitName | 是 | 用户ID | |
| fdContent | 是 | 反馈内容 | |
| feedSource | 是 | 反馈来源Web = 0,IOS = 1,IOSPad = 2,Android = 3,AndroidPad = 4,IPTV = 5,微信 = 6 | |
| files | fileName | 是 | 文件名 |
| customFileName | 是 | 物理文件名 | |
| timeLength | 否 | 时长 针对录音 | |
| sortCode | 是 | 排序 | |
| fileFormat | 是 | 格式 | |
| md5code | 是 | md5 | |
| fileSize | 是 | 大小 | |
| directoryPath | 是 | 路径 | |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
获取广告页地址,具体如下:
接口调用请求说明
http请求方式: Post
{WebPath}/UploadMini***.aspx
Post数据说明
Post数据示例如下:
{ md5:"JDJHSJ8GJGH8O98JJD",
name:"图片.jpg"//录音.amr,
userid:"10000100",
size:123,
total:1,
index:0,
data:"fffffffsgdfjgsjdfgjsdkjgdf"
}
参数说明
| 参数 | 是否必须 | 说明 | |
|---|---|---|---|
| md5 | 是 | md5码 | |
| name | 是 | 名字 | |
| userid | 是 | 用户ID | |
| size | 是 | 大小 | |
| total | 是 | 总大小 | |
| fileName | 是 | 索引 | |
| data | 是 | 文件的二进制数据流 | |
返回字段说明
成功:
{
"error":0,
"file":""1000010dfsdfashdfs.jpg""
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| file | string | error=0 返回文件路径 | |
| message | string | error=1 返回错误信息 | |
IOS检测更新2.0,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/******
GET数据说明
GET数据示例如下:
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| appVersion | 是 | app版本号 |
返回字段说明
成功:
{
"error":0,
"version":"0.1.0",
"description":"1.优化成长记忆; 2.添加活动分享。",
"apkurl":"http://www.smartdl.cc",
"apkname":"Smarkdl",
"forceupdate":false
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
| version | string | 版本 | |
| description | string | 更新信息 | |
| apkurl | string | 下载URl | |
| apkname | string | 名字 | |
| forceupdate | bool | 强制更新 | |
Android检测更新2.0,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| appVersion | 是 | app版本号 |
返回字段说明
成功:
{
"error":0,
"version":"0.1.0",
"description":"1.优化成长记忆; 2.添加活动分享。",
"apkurl":"",
"apkname":"",
"apkpath":"",
"updatePackagePath":"",
"forceupdate":false
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
| version | string | 版本 | |
| description | string | 更新信息 | |
| apkurl | string | 下载URl | |
| apkname | string | 名字 | |
| apkpath | string | apk地址 | |
| updatePackagePath | string | 当前版本增量更新包地址 | |
| forceupdate | bool | 强制更新 | |
获取服务端日期时间戳,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/****
GET数据说明
GET数据示例如下:
参数说明
| 参数 | 是否必须 | 说明 |
|---|
返回字段说明
成功:
{
"dateTime":"1487662807084"
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| dateTime | string | 服务端日期时间戳 | |
查询手机是否已授权,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST据示例如下:
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Code | 是 | 二维码code |
| PhoneType | 是 | 手机类型 |
返回字段说明
成功:
{
"error":0,
"LoginName":"",
"PassWord":"666666"
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
| LoginName | string | 登录名 | |
| PassWord | string | 密码 | |
更新是否显示家庭详细信息,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/******
POST数据说明
POST数据示例如下:
{
empID: "10004292",
isAppFamilyDetailShow: 0
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| empID | 是 | 学生empID |
| isAppFamilyDetailShow | 是 | 是否显示家庭详细信息(地址、电话),0否,1是 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
获取指定用户通讯录信息,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
userID: ""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
返回字段说明
成功:
{
"error":0,
data:{
"userID":"",
"groupId":"1",
"userType":"2",
"isAppFamilyDetailShow":0,
"employeeName":"王老师",
"employeeID":"1111111",
"userPhoto":"/Website/Content/logo.jpg",
"mobile":"",
"conner":"661",
"genderName":"男",
"departName":"101班",
"email":"661@qq.con",
"addres":"宁波高新区彩虹大道211号"
}
}
| 字段 | 类型 | 说明 |
|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 |
| message | string | error=1 返回错误信息 |
| userID | string | userID |
| groupId | string | groupId |
| employeeName | string | 姓名 |
| employeeID | string | 姓名 |
| userType | string | 类型 2 老师 3 学生 |
| isAppFamilyDetailShow | int | 是否显示家庭详细信息(地址、电话),0否,1是 |
| userPhoto | string | 头像 |
| mobile | string | 手机 |
| conner | string | 短号 |
| genderName | string | 性别 |
| departName | string | 部门(班级) |
| string | 邮箱(学生为空) | |
| addres | string | 家庭地址 |
修改监护人密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/****
POST数据说明
POST数据示例如下:
{
userID: "",
passWord: "",
newPassWord: "1598"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 父账户用户ID |
| passWord | 否 | 原密码 |
| newPassWord | 是 | 新密码 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 |
|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 |
| message | string | error=1 返回错误信息 |
检查家长是是否有设置监护人密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
userID: ""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 父账户用户ID |
返回字段说明
成功:
{
"error":0,
"data":{
hasGuardianPassword:0
}
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
| data | hasGuardianPassword | int | 是否有设置过监护人密码,0否,1是 | ||
验证监护人密码是否正确,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
userID: "",
passWord: "1234"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 父账户用户ID |
| passWord | 是 | 监护人密码 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
保存监护人,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
id:"",
unitID:"",
stuUserID: "",
linkTel: "",
relationTypeID: "",
photoPath: "",
isReceiveSMS: "1",
relationTypeName: "爸爸",
fullName: "陈张生"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 否 | 当修改监护人信息时为必填项 |
| stuUserID | 是 | 学生的用户ID |
| unitID | 是 | 学校ID |
| linkTel | 是 | 监护人名手机号 |
| relationTypeID | 是 | 关系ID |
| relationTypeName | 是 | 关系名称 |
| photoPath | 是 | 头像地址 |
| isReceiveSMS | 是 | 是否接收短信,0否,1是 |
| fullName | 是 | 监护人名称 |
| verCode | 是 | 验证码 |
| needCheckVerCode | 是 | 是否需要验证验证码0否,1是 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1 返回错误信息 | |||
获取监护人关系,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/******
GET数据说明
GET数据示例如下:
{
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data":[
{
"id":"",
"name":"爸爸"
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | id | string | 关系类型ID | ||
| name | string | 关系类型名称 | |||
查询监护人列表,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
userID: "10129580"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 学生的用户ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data":[
{
"id":"",
"userID":"",
"name":"陈张生",
"photoPath":"",
"mobile":"",
"relation":"爸爸",
"relationTypeID":"",
"IsReceiveSMS":1,
"IsPaid":1
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | id | string | 监护人记录ID | ||
| userID | string | 监护人用户ID | |||
| name | string | 姓名 | |||
| photoPath | string | 头像 | |||
| mobile | string | 电话 | |||
| relation | string | 关系 | |||
| relationTypeID | string | 关系类型ID | |||
| IsReceiveSMS | int | 是否开通短信,0否,1是 | |||
| isPaid | int | 是否已付过款,0否,1是 | |||
删除学生家庭成员,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
id: ""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
更新短信选项,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/***
POST数据说明
POST数据示例如下:
{
id: "",
isReceiveSMS:1
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | ID |
| isReceiveSMS | 是 | 是否开通短信,0否,1是 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
更新密码,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
loginName: "",
passWord: "1234"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| loginName | 是 | 父账户用户登录名 |
| passWord | 是 | 新密码 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
获取验证码接口,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| phone | 是 | 手机账户 |
| type | 是 | 0 忘记监护人密码 1 修改监护人手机,2 新增监护人 |
| userID | 是 | 用户ID |
POST数据示例如下:
{
"phone":"",
"type":"1",
"userID":""
}
返回字段说明
{
"error":0,
"verificationCode":"4521"
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 |
| message | string | 'error=1'时错误信息有值返回 |
| verificationCode | string | 验证码 |
查询成长记录,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
userID: "10129580"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 学生的用户ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data":[
{
"date":"2017-08-29",
"height":"173",
"weight":"60",
"photoPath":"",
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | date | string | 记录日期 | ||
| photoPath | string | 头像地址 | |||
| height | int | 身高(厘米) | |||
| weight | int | 体重(KG) | |||
保存成长记录,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
userID: "10008848",
height: "173",
weight: "60"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| height | 是 | 身高(厘米,整数) |
| weight | 是 | 体重(KG,整数) |
| photoPath | 是 | 头像地址 |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | error=1 返回错误信息 | |
搜索通讯录,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
userID: '',
searchContent:"121212"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| searchContent | 是 | 搜索内容 |
返回字段说明
成功:
{
"error":0,
"data":{
"userList":[
{
"userID":"10",
"userType":"2",
"isAppFamilyDetailShow":0,
"employeeName":"王老师",
"userPhoto":"/Website/Content/logo.jpg",
"mobile":"",
"conner":"661",
"genderName":"男",
"departName":"101班",
"guardian":"山爸爸",
"relationship":"父子",
"email":"661@qq.con",
"addres":"宁波高新区彩虹大道211号"
}
]
}
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1时错误信息 | |||
| userList | userID | string | 用户ID | ||
| employeeName | string | 姓名 | |||
| userType | string | 类型1教育局 2 老师 3 学生 | |||
| isAppFamilyDetailShow | int | 是否显示家庭详细信息(地址、电话),0否,1是 | |||
| userPhoto | string | 头像 | |||
| mobile | string | 手机 | |||
| conner | string | 短号 | |||
| genderName | string | 性别 | |||
| departName | string | 部门(班级) | |||
| guardian | string | 监护人(教师为空) | |||
| relationship | string | 监护人关系(教师为空) | |||
| string | 邮箱(学生为空) | ||||
| addres | string | 家庭地址 | |||
发送踢人推送,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/*****
POST数据说明
POST数据示例如下:
{
deviceToken:"123123123122412412",
userID:"",
loginName:""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| loginName | 是 | 当前登录名 |
| deviceToken | 是 | 当前设备token |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1时错误信息 | |||
删除设备token,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/ApiLoginApi/******
POST数据说明
POST数据示例如下:
{
deviceToken:"123123123122412412"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| deviceToken | 是 | 当前设备token |
返回字段说明
成功:
{
"error":0
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1时错误信息 | |||
获取账号被T状态,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/****
GET数据说明
GET数据示例如下:
{
deviceToken:"123123123122412412"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| deviceToken | 是 | 当前设备token |
返回字段说明
成功:
{
"error":0,
"state":0
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1时错误信息 | |||
| state | int | 状态,0没被T,1被T | |||
获取学历和民族列表,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/****
GET数据说明
GET数据示例如下:
{
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|
返回字段说明
成功:
{
"error":0,
"data":{
"nationList":[
"id":"XXXX",
"name":"XXXX"
],
"educationLevelList":[
"id":"XXXX",
"name":"XXXX"
],
}
}
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | error=1时错误信息 | |||
| nationList | id | string | 民族ID | ||
| name | string | 民族名称 | |||
| educationLevelList | id | string | 学历ID | ||
| name | string | 学历名称 | |||
获取学生信息,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
"userID":"10129580",
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 学生用户ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":[
{
"userID":"xxxxxx",
"gender":1,
"unitiveCode":"xxxxxx",
"studentCode":"xxxxxx",
"guardian":"xxxxxx",
"guardianRelation":"xxxxxx",
"guardianMobile":"xxxxxx",
"studentName":"xxxxxx",
"homeAddress":"xxxxxx",
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | userID | int | 学生用户ID | ||
| gender | int | 性别 | |||
| unitiveCode | string | 学籍号 | |||
| studentCode | string | 学号 | |||
| guardian | string | 监护人 | |||
| guardianRelation | string | 监护人关系 | |||
| guardianMobile | string | 监护人手机号 | |||
| studentName | string | 学生姓名 | |||
| homeAddress | string | 地址 | |||
更新学生信息,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/****
POST数据说明
POST数据示例如下:
{
"gender": 1,
"guardian": "彭之耀",
"guardianMobile": "18407229825",
"guardianRelation": "爸爸",
"homeAddress": "宁波",
"studentCode": "002",
"studentName": "彭小耀",
"unitiveCode": "000225210",
"userID": "10437806",
"unitID": "",
"operatorUserID": "",
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 学生用户ID |
| gender | 是 | 性别 |
| guardian | 是 | 监护人 |
| guardianMobile | 是 | 监护人号码 |
| guardianRelation | 是 | 监护人关系 |
| homeAddress | 是 | 地址 |
| studentCode | 是 | 学号 |
| studentName | 是 | 学生姓名 |
| unitiveCode | 是 | 学籍主号 |
| unitID | 是 | 当前用户所在单位ID |
| operatorUserID | 是 | 当前操作人ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
获取通讯录人员名单,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
"unitID":"",
"employeeID":"",
"userType":"0",
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 单位ID |
| employeeID | 是 | 人员ID |
| userType | 是 | 用户类型 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
登录人为局或校
{
"error":0,
"data":[
{
"fristPy":"C",
"userMeg":[
{
"unitID":"",
"employeeID":"10000250",
"userID":"10008828",
"name":"曹栋梁",
"photoPath":"",
"userType":2
}
]
},
{
"fristPy":"J",
"userMeg":[
{
"unitID":"",
"employeeID":"10016242",
"userID":"10409345",
"name":"江芳",
"photoPath":"",
"userType":2
}
]
},
{
"fristPy":"K",
"userMeg":[
{
"unitID":"",
"employeeID":"10017545",
"userID":"10436599",
"name":"课程选修2",
"photoPath":"",
"userType":2
}
]
},
{
"fristPy":"W",
"userMeg":[
{
"unitID":"",
"employeeID":"10021925",
"userID":"10585410",
"name":"吴三",
"photoPath":"",
"userType":2
}
]
},
{
"fristPy":"Y",
"userMeg":[
{
"unitID":"",
"employeeID":"10011884",
"userID":"10314126",
"name":"杨孝",
"photoPath":"http://oss.zjzdy.net/APP/20170711/bf5f7bd9c283dfcf0bdd7a00e90711bc.jpg",
"userType":2
},
{
"unitID":"",
"employeeID":"10015439",
"userID":"10394386",
"name":"严浩",
"photoPath":"http://oss.zjzdy.net/APP/20181229/19fedac3165d2085222491287896e657.jpg",
"userType":2
}
]
}
]
}
登录人为家长或者学生 数据为班级授课教师和班级学生
{
"error":0,
"teacherData":[
{
"unitID":"",
"employeeID":"10000241",
"userID":"10394386",
"name":"尤平",
"photoPath":"http://oss.zjzdy.net/APP/20170605/4d75d0098604c86de1710450d3a4b016.jpg",
"courseName":"语文老师",
"userType":2
},
{
"unitID":"",
"employeeID":"10020184",
"userID":"10394386",
"name":"朱礼松",
"photoPath":"http://oss.zjzdy.net/APP/20180425/ddd2e1ea23822e5c9e3635cfd4936cc6.jpg",
"courseName":"数学老师",
"userType":2
},
{
"unitID":"",
"employeeID":"10010083",
"userID":"10394386",
"name":"俞琪",
"photoPath":"http://oss.zjzdy.net/APP/20181229/7f223c1b691abc345bf6705fd68fe0f8.jpg",
"courseName":"班主任",
"userType":2
}
],
"studentData":[
{
"unitID":"",
"employeeID":"10277135",
"userID":"10394386",
"name":"李1",
"photoPath":"",
"userType":3
},
{
"unitID":"",
"employeeID":"10277136",
"userID":"10394386",
"name":"李2",
"photoPath":"",
"userType":3
},
{
"unitID":"",
"employeeID":"10277137",
"userID":"10394386",
"name":"李3",
"photoPath":"",
"userType":3
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data | string | 返回json数据 | |
| data.unitID | string | 单位ID | |
| data.employeeID | string | 人员ID | |
| data.userID | string | 用户ID | |
| data.name | string | 人员名称 | |
| data.photoPath | string | 头像路径 | |
| data.courseName | string | 授课名称 | |
| data.userType | int | 用户类型 | |
通讯录获取学校列表,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
"unitID":"10000264",
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 单位ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":[
{
"sectionName":"幼儿园",
"cityList":[
{
"areaName":"鄞州",
"schoolList":[
{
"unitID":"",
"unitName":"学之路学校",
"path":""
}
]
}
]
},
{
"sectionName":"小学",
"cityList":[
{
"areaName":"鄞州",
"schoolList":[
{
"unitID":"",
"unitName":"学之路学校",
"path":""
}
]
},
{
"areaName":"其他区/县",
"schoolList":[
{
"unitID":"10000226",
"unitName":"学之路村校",
"path":""
}
]
}
]
},
{
"sectionName":"初中",
"cityList":[
{
"areaName":"其他区/县",
"schoolList":[
{
"unitID":"10000226",
"unitName":"学之路村校",
"path":""
}
]
},
{
"areaName":"鄞州",
"schoolList":[
{
"unitID":"",
"unitName":"学之路学校",
"path":""
}
]
}
]
}
]
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data | string | 'data' 返回json数据 | |
| sectionName | string | 学段名称 | |
| cityList | [] | 地区列表 | |
| cityList.areaName | [] | 地区名称 | |
| schoolList | [] | 学段下面的学校列表 | |
| schoolList.unitID | string | 单位ID | |
| schoolList.unitName | string | 单位名称 | |
| schoolList.path | string | 单位头像 | |
通讯录获取局-校组织架构,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/******
GET数据说明
GET数据示例如下:
{
"unitID":"10000264",
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 单位ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":[
{
"unitID":"",
"unitName":"学之路学校",
"departmentList":[
{
"id":"10002390",
"name":"研发",
"personList":[
]
},
{
"id":"10002391",
"name":"测试",
"personList":[
]
},
{
"id":"10002392",
"name":"设计",
"personList":[
]
},
{
"id":"10002393",
"name":"美工",
"personList":[
]
},
{
"id":"10002394",
"name":"运营",
"personList":[
]
},
{
"id":"10002395",
"name":"实施",
"personList":[
]
},
{
"id":"10002396",
"name":"学校部门",
"personList":[
{
"unitID":"",
"employeeID":"10011884",
"userID":"10011884",
"name":"杨孝",
"photoPath":"http://oss.zjzdy.net/APP/20170711/bf5f7bd9c283dfcf0bdd7a00e90711bc.jpg",
"userType":2
}
]
},
{
"id":"10002512",
"name":"教师组",
"personList":[
]
}
]
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data | string | 'data' 返回json数据 | |
| unitID | string | 部门ID | |
| unitName | string | 部门名称 | |
| data.departmentList | string | 部门人员列表 | |
| data.departmentList.id | string | 部门ID | |
| data.departmentList.name | string | 部门名称 | |
| data.personList | string | 人员列表 | |
| data.personList.unitID | string | 单位ID | |
| data.personList.employeeID | string | 人员ID | |
| data.personList.userID | string | 用户ID | |
| data.personList.name | string | 人员名称 | |
| data.personList.photoPath | string | 头像地址 | |
| data.personList.userType | int | 用户类型 | |
通讯录获取群组信息,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/****
GET数据说明
GET数据示例如下:
{
"unitID":"",
"userID":""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 单位ID |
| userID | 是 | 用户ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":[
{
"groupID":"10000039",
"groupName":"研发组",
"groupType":0,
"userNum":5,
"photoPathList":[
{
"path":"http://oss.zjzdy.net/APP/20181208/64bc65908b138b6c854b7dd4b5909e5b.jpg"
},
{
"path":"http://oss.zjzdy.net/APP/20181229/89493c5f893352719615dd9df8d7aced.jpg"
},
{
"path":"http://oss.zjzdy.net/APP/20170605/4d75d0098604c86de1710450d3a4b016.jpg"
},
{
"path":"http://xzl.zjzdy.net/upload/avatars/User10008841/small20170325235004.jpg"
},
{
"path":"http://oss.zjzdy.net/HeadImage/HREmployee/10008856/medium.jpg"
}
]
},
{
"groupID":"10000112",
"groupName":"测试部",
"groupType":0,
"userNum":1,
"photoPathList":[
{
"path":"http://oss.zjzdy.net/APP/20181229/7f223c1b691abc345bf6705fd68fe0f8.jpg"
}
]
},
{
"groupID":"10000326",
"groupName":"运营组",
"groupType":0,
"userNum":1,
"photoPathList":[
]
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data | string | 'data' 返回json数据 | |
| data.groupID | string | 群组ID | |
| data.groupName | string | 群组名称 | |
| data.groupType | int | 1:个人群组,2:公共群组。群组类型 | |
| data.userNum | int | 群组总人数 | |
| data.photoPathList | [ ] | 所有群员头像 | |
| data.photoPathList.path | string | 头像地址 | |
通讯录获取群组人员信息,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/****
GET数据说明
GET数据示例如下:
{
"groupID":"10000255",
"groupType":2
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| groupID | 是 | 群组ID |
| groupType | 是 | 群组类型 1:个人群组,2:公共群组 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":[
{
"groupID":"10000255",
"groupName":"1111111111111",
"groupType":2,
"userNum":25,
"employeeList":[
{
"fristPy":"B",
"userList":[
{
"unitID":"",
"userID":"10546455",
"employeeID":"10021169",
"employeeName":"班主任-小",
"path":"",
"userType":2
}
]
},
{
"fristPy":"C",
"userList":[
{
"unitID":"",
"userID":"",
"employeeID":"10000239",
"employeeName":"陈张生1",
"path":"http://oss.zjzdy.net/APP/20181229/89493c5f893352719615dd9df8d7aced.jpg",
"userType":2
}
]
},
{
"fristPy":"D",
"userList":[
{
"unitID":"",
"userID":"10314127",
"employeeID":"10011885",
"employeeName":"董君倬",
"path":"http://oss.zjzdy.net/APP/20170718/e07aa641bb472ba4fee56acc808ff9c5.jpg",
"userType":2
}
]
}
]
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data | string | 'data' 返回json数据 | |
| data.groupID | string | 群组ID | |
| data.groupName | string | 群组名称 | |
| data.groupType | int | 1:个人群组,2:公共群组。群组类型 | |
| data.userNum | int | 群组总人数 | |
| data.employeeList | [ ] | 所有群员 | |
| data.employeeList.fristPy | string | 分组拼音 | |
| data.employeeList.userList | [] | 所有群员信息 | |
| data.userList.unitID | string | 单位ID | |
| data.userList.userID | string | 用户ID | |
| data.userList.employeeID | string | 人员ID | |
| data.userList.employeeName | string | 人员姓名 | |
| data.userList.path | string | 头像地址 | |
| data.userList.userType | int | 用户类型 | |
通讯录查看他人个人信息,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
employeeID: "10277135",
unitID: "",
userType: 3
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| employeeID | 是 | 人员ID |
| unitID | 是 | 单位ID |
| userType | 是 | 用户类型 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
userType=4 查询家长个人信息
{
"error":0,
"data":[
{
"employeeID":"10223206", 人员ID
"userID":"10129581", 用户ID
"unitID":"", 单位ID
"path":"http://o5.jpg", 头像地址
"name":"贾路句", 家长姓名
"sex":"女", 性别
"studentName":"胡梦", 学生姓名
"relation":"妈妈", 关系
"linkTel":"", 家长手机号码
"emergencyTel":"", 紧急联系电话
"address":"", 家庭住址
"signature":"", 签名
"userType":4 用户类型
}
]
}
userType=3 查询学生个人信息
{
"error":0,
"data":[
{
"employeeID":"10004291", 人员ID
"userID":"10129581", 用户ID
"unitID":"", 单位ID
"path":"http://oss.zjzdy.net/APP/20170915.jpg", 头像地址
"name":"陈海诺", 学生姓名
"sex":"女", 性别
"birthDay":"2016-10-24T00:00:00", 出生日期
"className":"404班", 班级
"guardianMobile":"", 监护人电话
"guardianRelation":"爸爸", 监护人关系
"address":"宁波研发圆502", 家庭住址
"signature":"", 签名
"userType":3 用户类型
}
]
}
userType=2 查询教师个人信息
{
"error":0,
"data":[
{
"employeeID":"10010083", 人员ID
"userID":"10129581", 用户ID
"unitID":"", 单位ID
"name":"俞琪", 人员姓名
"sex":"女", 性别
"path":"http://oss.jpg", 头像地址
"unitName":"学之路学校", 单位名称
"departmentName":"测试", 部门名称
"mobile":"", 手机号码
"cornet":"", 短号
"officePhone":"", 办公电话
"email":"", 邮箱
"signature":"", 签名
"userType":2 用户类型
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data | string | 'data' 返回json数据 | |
| data.employeeID | string | 人员ID | |
| data.empName | string | 人员姓名 | |
| data.photoPath | string | 头像地址 | |
| data.unitName | string | 单位名称 | |
| data.departmentName | string | 部门名称 | |
| data.mobile | string | 手机号码 | |
| data.cornet | string | 短号 | |
| data.officePhone | string | 办公电话 | |
| data.email | string | 邮箱 | |
| data.signature | string | 签名 | |
| data.userType | int | 用户类型 2:教师,3:学生,4:家长 | |
通讯录查看班级群组,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
"employeeID": '10000239',
"unitID": '',
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| employeeID | 是 | 人员ID |
| unitID | 是 | 单位ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":[
{
"classAdjustID":"345825ca2815420e805f3a0edb7ec3bb",
"unitID":"",
"groupName":"五年级404班家长群",
"groupType":2,
"userNum":94,
"photoPathList":[
{
"path":"http://oss.zjzdy.net/APP/20170822/65fbd7c3ba8d7096a27c0cbe3c0795ba.jpg"
}
]
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data | string | 'data' 返回json数据 | |
| data.classAdjustID | string | 学期班级ID | |
| data.unitID | string | 单位ID | |
| data.groupName | int | 群组名称 | |
| data.groupType | int | 1:班级群 2:家长群。群组类型 | |
| data.userNum | int | 群组人数 | |
| data.pathList | [] | 头像数组 | |
| data.pathList.path | string | 头像地址 | |
通讯录查看班级群组人员信息,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/ApiLoginApi/*****
GET数据说明
GET数据示例如下:
{
unitID: "",
classAdjustID: "117860749e4e46b08312ae641419253a",
groupType: 2
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 单位ID |
| classAdjustID | 是 | 学期班级ID |
| groupType | 是 | 群组类型 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
家长群
{
"error":0,
"groupType":2,
"data":[
{
"userNum":3,
"employeeList":[
{
"fristPy":"C",
"userList":[
{
"employeeID":"",
"userID":"",
"unitID":"",
"path":"",
"employeeName":"陈海诺爸爸",
"userType":4
}
]
},
{
"fristPy":"D",
"userList":[
{
"employeeID":"",
"userID":"",
"unitID":"",
"path":"",
"employeeName":"徐文静母亲",
"userType":4
}
]
},
{
"fristPy":"F",
"userList":[
{
"employeeID":"",
"userID":"",
"unitID":"",
"path":"",
"employeeName":"方刘伟爸爸",
"userType":4
}
]
}
]
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data | string | 'data' 返回json数据 | |
| data.groupType | int | 1:班级群 2:家长群。群组类型 | |
| data.userNum | int | 群组人数 | |
| data.employeeList | [] | 群成员 | |
| data.employeeList.fristPy | string | 分组拼音 | |
| data.employeeList.userList | [] | 人员列表 | |
| data.employeeList.userList.userID | string | 用户ID | |
| data.employeeList.userList.unitID | string | 单位ID | |
| data.employeeList.userList.path | string | 头像地址 | |
| data.employeeList.userList.employeeName | string | 姓名 | |
| data.employeeList.userList.userType | int | 用户类型 | |
通讯录查询当前联系人是否被收藏,具体如下:
接口调用请求说明
http请求方式: Post
{WebPath}/api/ApiLoginApi/*****
Post数据说明
Post数据示例如下:
{
unitID: "",
userID: "",
byUnitID: "",
byUserID: "20000002"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 当前登录人单位ID |
| userID | 是 | 当前登录人UserID |
| byUnitID | 是 | 被操作人UnitID |
| byUserID | 是 | 被操作人UserID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"state":1,
"contactsID":""
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| state | int | 收藏状态,0:未收藏,1:已收藏 | |
| contactsID | string | 收藏ID | |
通讯录联系人收藏/取消收藏,具体如下:
接口调用请求说明
http请求方式: Post
{WebPath}/api/ApiLoginApi/*****
Post数据说明
Post数据示例如下:
{
contactsID: "",
unitID: "",
userID: "100234",
name: "王",
byUnitID: "",
byUserID: "200234",
byUserType: 2,
byName: "李"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| contactsID | 是 | 收藏ID |
| unitID | 是 | 当前登录人单位ID |
| userID | 是 | 当前登录人UserID |
| name | 是 | 当前登录人姓名 |
| byUnitID | 是 | 被操作人UnitID |
| byUserID | 是 | 被操作人UserID |
| byUserType | 是 | 被操作人用户类型 |
| byName | 是 | 被操作人姓名 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"state":1,
"contactsID":""
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| state | int | 收藏状态,0:未收藏,1:已收藏 | |
| contactsID | string | 收藏ID | |
通讯录获取收藏联系人,具体如下:
接口调用请求说明
http请求方式: Get
{WebPath}/api/ApiLoginApi/****
Get数据说明
Get数据示例如下:
{
userID: "",
unitID: ""
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 当前登录人单位ID |
| userID | 是 | 当前登录人用户ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":[
{
"employeeID":"",
"unitID":"",
"userID":"",
"name":"",
"photoPath":"",
"userType":2
},
{
"employeeID":"",
"unitID":"",
"userID":"",
"name":"",
"photoPath":"",
"userType":3
},
{
"employeeID":"",
"unitID":"",
"userID":"",
"name":"胡图图",
"photoPath":"",
"userType":3
},
{
"employeeID":"",
"unitID":"",
"userID":"",
"name":"",
"photoPath":"",
"userType":4
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 'error' 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1' 返回新错误信息 | |
| data.employeeID | string | 人员ID | |
| data.unitID | string | 单位ID | |
| data.userID | string | 用户ID | |
| data.name | string | 人员名称 | |
| data.photoPath | string | 头像路径 | |
| data.userType | int | 用户类型 | |