关于使用规则,请注意:
关于接口文档,请注意:
验证Token,具体如下:
接口调用请求说明
http请求方式: GET {WebPath}/api/ApiLoginApi/CheckTokenIsValid
GET数据说明
GET数据示例如下:
{ "token":"tSiw3CkiVzcfR8klQ9eRaO4t+hsAQemn0Kt39f6mzhgEr4bmp+1dqMt0I+WapO/51lgDQRVaW8Styzh5KfPT4urvXl5gXIWIu8iL1f4hmK8YgLKHvKFmhu2vT6X5PKgzwuEdoUbNm2qtCai90waM5oHnRi0hfE1WWFReQvyq/15YhSXLp71m0WRANzregR8A5ez7eBTly51FwhgvVAG1CA==", "userID":"10008817", "unitID":"10000006", "employeeID":"10000239", "loginName":"13566593701", "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/QRLoginAuthorize
POST数据说明
POST数据示例如下:
{ "userID":"10000001", "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/GetCustomizeMenu4
POST数据说明
POST数据示例如下:
{ "userID":"18069067009", "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/LoginGetMutilRole
POST数据说明
POST数据示例如下:
{ "loginName":"15906512352", "passWord":"8888888", loginType: "" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
loginName | 是 | 当前登录用户名 |
passWord | 是 | 当前登录用户密码 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
老师: { "error":0, "mutilRoleList": { "userID":"10000001", "empName":"teacher", "gradeName":"一年级", "deptName":"教务处", "unitName":"学之路", "userType":"2", "userTypeName":"老师", "photoPath":"http://192.168.1.126:6005/upload/avatars/HR_Employee10001/large.jpg" }, { "userID":"10000002", "empName":"student", "gradeName":"一年级", "deptName":"101班", "unitName":"学之路", "userType":"3", "userTypeName":"学生", "photoPath":"http://192.168.1.126:6005/upload/avatars/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/LoginSys
POST数据说明
POST数据示例如下:
{ loginName: '13400000000', userID: "10000001", passWord: '', mobileMac: "", clientModel: "", clientVersion: "", loginType: "2", fatherLoginName:"13566593701" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
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":"1", "userName":"admin", "password":"123456" "userType":2, "sex":1, "empID":"20000472", "empCode":null, "empName":"i老师助手", "depName":null, "mobile":"13586500193", "loginLastTime":null, "gradeName":null, "edunitID":"1", "edunitName":null, "unitLogo":"http://10.10.1.210:91/Model/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 "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":"http://10.10.1.210:91/Model/addimg.png", "about":"http://demo.zjzdy.net/Api/About.html", "helper":"http://demo.zjzdy.net/Api/Help.html", "token":"df7a8fasdf6a7sdfa7s6f7", "muneList":[{ "menuName":"网站", "menuUrl":"http://www.smartdl.cc" }, { "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 | 用户名 | |
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/UpdatePersonInfo2
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 用户ID |
否 | email(老师) | |
cornet | 否 | 短号(老师) |
sex | 否 | 性别(0 女 1男) |
photoPath | 否 | 头像(字符流) |
address | 否 | 地址(学生) |
token | 是 | token |
POST数据示例如下:
{ userID:"1" email: "13566793341@qq.com", cornet: "6652", mobile: "13566593701", sex: "1", photoPath: "dfgsdfasdgsfgfhgfhg", address: "宁波高新区世纪大道", token: "kjkdfsdfsdkfdjkjk", }
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 | |
photoSmall | string | 头像 | |
photoLarge | string | 头像 |
删除记忆,具体如下:
接口调用请求说明
http请求方式: GET {WebPath}/api/ApiLoginApi/GetAddresList
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":"http://192.168.1.126:6005/Website/Content/logo.jpg", "mobile":"13566593701", "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请求方式: GET {WebPath}/api/ApiLoginApi/GetVerificationCode
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/ConfirmVerificationCode
GET数据说明
参数 | 是否必须 | 说明 |
---|---|---|
phone | 是 | 手机账户 |
verCode | 是 | 验证码 |
GET数据示例如下:
{ "phone":"13564589685" "varCode":"4582" }
返回字段说明
{ "error":0 }
返回字段说明
字段 | 类型 | 说明 |
---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 |
message | string | 'error=1'时错误信息有值返回 |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/UpdatePassword
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/ForgetPassWord
POST数据说明
POST数据示例如下:
{ loginName: "1", passWord: "123456", }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
loginName | 是 | 用户名 |
passWord | 是 | 新密码 |
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/UpdateLoginName
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/UpdateMobile
POST数据说明
POST数据示例如下:
{ userID: "1", mobile: "13566593701", }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 用户ID |
mobile | 是 | 新手机号码 |
token | 是 | token |
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/SetWorkTimeRemind
POST数据说明
POST数据示例如下:
{ userID: "1", workTimeRemind: 1, nodisturb: 1, nodisturbStart: "9:30", nodisturbEnd: "15:30" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 用户ID |
workTimeRemind | 否 | 是否提醒(0否1是) |
nodisturb | 否 | 是否提醒(0否1是) |
nodisturbStart | 否 | nodisturb 设置 必填 |
nodisturbEnd | 否 | nodisturb 设置 必填 |
token | 是 | token |
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 |
获取付费项目,具体如下:
接口调用请求说明
http请求方式: GET {WebPath}/api/ApiLoginApi/GetSMSPayItem
GET数据说明
GET数据示例如下:
{ unitID:"10000001", 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/PayMoney
Post数据说明
Post数据示例如下:
{ channel: "alipay_wap" , subject: "短信支付" , body: "一年的短信费用" , amount: 1 , userID: "10000001" , empName: "管理员" , months: "3" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
channel | 是 | 支付使用的第三方支付渠道 |
subject | 是 | 商品的标题 |
body | 是 | 商品的描述 |
amount | 是 | 订单总金额, 单位为对应币种的最小货币单位,例如:人民币为分(如订单总金额为 1 元,此处请填 100)。 |
userID | 是 | 用户ID。 |
empName | 是 | 姓名。 |
months | 是 | 付款月数 |
返回字段说明
成功: { "error":0, "charge":{ "id":"ch_9Ka1a5Ta5yj9efHmjPrfvH08", "object":"charge", "created":1470976321, "livemode":false, "paid":false, "refunded":false, "app":"app_DKWLKKDu9eLODmnv", "channel":"alipay_wap", "order_no":"1234567896", "client_ip":"127.0.0.1", "amount":1, "amount_settle":1, "currency":"cny", "subject":"短信支付", "body":"一年的短信费用", "extra":{ "success_url":"http://pay.zjzdy.net/api/charges/success", "cancel_url":"http://pay.zjzdy.net/api/charges/cancel" }, "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":"https://mapi.alipay.com/gateway.do", "_input_charset":"utf-8", "body":"一年的短信费用", "it_b_pay":"2016-08-13 12:32:01", "notify_url":"https%3A%2F%2Fapi.pingxx.com%2Fnotify%2Fcharges%2Fch_9Ka1a5Ta5yj9efHmjPrfvH08", "out_trade_no":"1234567896", "partner":"2008808933961979", "payment_type":"1", "return_url":"http%3A%2F%2Fpay.zjzdy.net%2Fapi%2Fcharges%2Fsuccess", "seller_id":"2008808933961979", "service":"alipay.wap.create.direct.pay.by.user", "subject":"短信支付", "total_fee":"0.01", "sign":"q2oEnkJxdmYRUfCkSPDRq279VZpXrno0iGVHT9Cf1mPoNAEUrRvXHIYJK5ap1D+gV8L/73VDBeX7DbLKS598Yv6gFKcBocI3hK+aZ2yrW5yo+lA7rfjbDSMHZAcqxU2LFTT2feoyoCqWw/pfmRWghrgv/JTYPCih2ZA7y7vsgak=", "sign_type":"RSA" } }, "description":null } }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 | |
itemName | string | 项目 | |
price | string | 价格 |
获取广告页地址,具体如下:
接口调用请求说明
http请求方式: GET {WebPath}/api/ApiLoginApi/GetAdUrl
GET数据说明
GET数据示例如下:
{ unitID: "10000001" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
unitID | 是 | 学校ID |
返回字段说明
成功: { "error":0, "adUrl":"http://10.10.0.210:90/Model/addimg.png" }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 | |
adUrl | string | 广告Url |
获取广告页地址,具体如下:
接口调用请求说明
http请求方式: Post {WebPath}/api/ApiLoginApi/FeedBack
Post数据说明
Post数据示例如下:
{ userID: "10000035", empName: "管理员", unitID: "10000035", unitName: "智慧学校", fdContent: "test", feedSource:1, files: [{ fileName: "image1", customFileName:"22222", sortCode: 1, fileFormat: ".jpg", fileSize: "123", timeLength: "100", directoryPath: "medium20160629121905.jpg" }] }
参数说明
参数 | 是否必须 | 说明 | |
---|---|---|---|
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 | 是 | 格式 | |
fileSize | 是 | 大小 | |
directoryPath | 是 | 路径 |
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 |
获取广告页地址,具体如下:
接口调用请求说明
http请求方式: Post {WebPath}/UploadMinimal.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/GetIOSVersion2
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/GetAndroidVersion2
GET数据说明
GET数据示例如下:
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
appVersion | 是 | app版本号 |
返回字段说明
成功: { "error":0, "version":"0.1.0", "description":"1.优化成长记忆; 2.添加活动分享。", "apkurl":"http://www.smartdl.cc", "apkname":"Smarkdl", "apkpath":"http://xzl.zjzdy.net/Api/AppDown/android/v1.0.6.apk", "forceupdate":false }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 | |
version | string | 版本 | |
description | string | 更新信息 | |
apkurl | string | 下载URl | |
apkname | string | 名字 | |
apkpath | string | apk地址 | |
forceupdate | bool | 强制更新 |
获取服务端日期时间戳,具体如下:
接口调用请求说明
http请求方式: GET {WebPath}/api/ApiLoginApi/GetDateTime
GET数据说明
GET数据示例如下:
参数说明
参数 | 是否必须 | 说明 |
---|
返回字段说明
成功: { "dateTime":"1487662807084" }
字段 | 类型 | 说明 | |
---|---|---|---|
dateTime | string | 服务端日期时间戳 |
查询手机是否已授权,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/SearchIsMobileLogin
POST数据说明
POST据示例如下:
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
Code | 是 | 二维码code |
PhoneType | 是 | 手机类型 |
返回字段说明
成功: { "error":0, "LoginName":"13566593701", "PassWord":"666666" }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 | |
LoginName | string | 登录名 | |
PassWord | string | 密码 |
更新是否显示家庭详细信息,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/SetAppFamilyDetailShow
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/SearchContactInfoByUser
GET数据说明
GET数据示例如下:
{ userID: "10008817" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 用户ID |
返回字段说明
成功: { "error":0, data:{ "userID":"10008817", "groupId":"1", "userType":"2", "isAppFamilyDetailShow":0, "employeeName":"王老师", "employeeID":"1111111", "userPhoto":"http://192.168.1.126:6005/Website/Content/logo.jpg", "mobile":"13566593701", "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/UpdeteGuardianPassword
POST数据说明
POST数据示例如下:
{ userID: "10008817", passWord: "", newPassWord: "1598" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 父账户用户ID |
passWord | 否 | 原密码 |
newPassWord | 是 | 新密码 |
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 |
---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 |
message | string | error=1 返回错误信息 |
检查家长是是否有设置监护人密码,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/CheckHasGuardianPassword
POST数据说明
POST数据示例如下:
{ userID: "10008817" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
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/CheckGuardianPassword
POST数据说明
POST数据示例如下:
{ userID: "10008817", passWord: "1234" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 父账户用户ID |
passWord | 是 | 监护人密码 |
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 | |||
---|---|---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |||
message | string | error=1 返回错误信息 |
保存监护人,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/SaveGuardian
POST数据说明
POST数据示例如下:
{ id:"", unitID:"10000006", stuUserID: "10008848", linkTel: "13566593701", relationTypeID: "10000001", 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/GetRelationType
GET数据说明
GET数据示例如下:
{ }
参数说明
参数 | 是否必须 | 说明 |
---|
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{ "error": 0, "data":[ { "id":"10000001", "name":"爸爸" } ] }
返回字段说明
字段 | 类型 | 说明 | |||
---|---|---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |||
message | string | 'error=1'时错误信息有值返回 | |||
data | id | string | 关系类型ID | ||
name | string | 关系类型名称 |
查询监护人列表,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/SearchGuardianList
POST数据说明
POST数据示例如下:
{ userID: "10129580" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 学生的用户ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{ "error": 0, "data":[ { "id":"10000001", "userID":"10008817", "name":"陈张生", "photoPath":"", "mobile":"13566593701", "relation":"爸爸", "relationTypeID":"10000001", "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/DelGuardian
POST数据说明
POST数据示例如下:
{ id: "10000001" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
id | 是 | ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{ "error": 0 }
返回字段说明
字段 | 类型 | 说明 | |||
---|---|---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |||
message | string | 'error=1'时错误信息有值返回 |
更新短信选项,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/UpdateSMSOption
POST数据说明
POST数据示例如下:
{ id: "10000001", isReceiveSMS:1 }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
id | 是 | ID |
isReceiveSMS | 是 | 是否开通短信,0否,1是 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{ "error": 0 }
返回字段说明
字段 | 类型 | 说明 | |||
---|---|---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |||
message | string | 'error=1'时错误信息有值返回 |
更新密码,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/ForgetGuardianPassWord
POST数据说明
POST数据示例如下:
{ loginName: "13566593701", passWord: "1234" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
loginName | 是 | 父账户用户登录名 |
passWord | 是 | 新密码 |
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 |
获取验证码接口,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/GetVerCode
POST数据说明
参数 | 是否必须 | 说明 |
---|---|---|
phone | 是 | 手机账户 |
type | 是 | 0 忘记监护人密码 1 修改监护人手机,2 新增监护人 |
userID | 是 | 用户ID |
POST数据示例如下:
{ "phone":"13566593701", "type":"1", "userID":"10008817" }
返回字段说明
{ "error":0, "verificationCode":"4521" }
返回字段说明
字段 | 类型 | 说明 |
---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 |
message | string | 'error=1'时错误信息有值返回 |
verificationCode | string | 验证码 |
查询成长记录,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/SearchGrowthRecord
POST数据说明
POST数据示例如下:
{ userID: "10129580" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 学生的用户ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{ "error": 0, "data":[ { "date":"2017-08-29", "height":"173", "weight":"60" } ] }
返回字段说明
字段 | 类型 | 说明 | |||
---|---|---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |||
message | string | 'error=1'时错误信息有值返回 | |||
data | date | string | 记录日期 | ||
height | int | 身高(厘米) | |||
weight | int | 体重(KG) |
保存成长记录,具体如下:
接口调用请求说明
http请求方式: POST {WebPath}/api/ApiLoginApi/SaveGrowthRecord
POST数据说明
POST数据示例如下:
{ userID: "10008848", height: "173", weight: "60" }
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
userID | 是 | 用户ID |
height | 是 | 身高(厘米,整数) |
weight | 是 | 体重(KG,整数) |
返回字段说明
成功: { "error":0 }
字段 | 类型 | 说明 | |
---|---|---|---|
error | int | 返回值:'0'表示成功,'1'表示失败 | |
message | string | error=1 返回错误信息 |