知识元平台PHP API接口文档

知识元

更新历史

目录

【备注】

1. 全局返回码说明

每次调用接口时，可能获得正确或错误的返回码，开发者可以根据返回码信息调试接口，排查错误。

HTTP请求状态返回格式

错误样例
{
"status": 40013,
"message": {"0":"invalid appid"}
}
成功样例
{
"status": 200,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}

1.用户中心

1.1 用户注册

接口地址

/v1/user/register

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
username	是	Long	用户名
mobile	否	Long	手机号
password	是	String	密码

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"username":13453077412，"password":"123456"} http://api.sewise.com/v1/user/register
Response
{"status":200,"data":{"userId":"31"}}

1.2 用户登录

接口地址

/v1/user/auth

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
username	是	Long	手机号
password	是	String	密码

或

参数	必选	类型	说明
RequestBody
access_token	是	String	用户授权码

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"username":13453077412，"password":"123456"} http://api.sewise.com/v1/user/auth
Response
{"status":200,"data":{"userId":"23","access_token":"JfKXafCnfSZrCEkShTIcM3suBFwUBAQi3eocJ5Ol","expire":"2016-07-09 10:51:25"}}

1.3 用户基本信息

接口地址

/v1/user/accountInfo

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （GET）

参数	必选	类型	说明
PathParam
access_token	是	String	授权签名（用户登陆成功返回的access_token）
sn	否	String	如传则返回该用户在主机的用户名username

例如： /v1/user/accountInfo?access_token={access_token}
或：

参数	必选	类型	说明
RequestHeader
access_token	是	String	授权签名（用户登陆成功返回的access_token）
sn	否	String	如传则返回该用户在主机的用户名username

方式二 （POST）

参数	必选	类型	说明
RequestHeader
token	是	String	管理员/内部调用授权签名
RequestBody
userId	是	Long	用户id

方式三 （POST）

参数	必选	类型	说明
RequestHeader
unLoginToken	是	String	免登陆授权签名
RequestBody
userId	是	Long	用户id
sn	否	String	如传则返回该用户在主机的用户名username

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":22，"token":"#########"} http://api.sewise.com/v1/user/accountInfo
Response
{"status":200,"data":{"userId":"22","mobile":"18675448003","userType":"1","creationDate":"2016-07-06 10:34:54","accountStatus":"1","lastLogin":"2016-07-06 17:42:22","isDelete":"N"}}

1.4 用户详细信息

接口地址

/v1/user/userInfo

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （GET）

参数	必选	类型	说明
PathParam
access_token	是	String	授权签名（用户登陆成功返回的access_token）

例如： /v1/user/userInfo?access_token={access_token}
或：

参数	必选	类型	说明
RequestHeader
access_token	是	String	授权签名（用户登陆成功返回的access_token）

方式二 （POST）

参数	必选	类型	说明
RequestHeader
token	是	String	管理员/内部调用授权签名
RequestBody
userId	是	Long	用户id

方式三 （POST）

参数	必选	类型	说明
RequestHeader
unLoginToken	是	String	免登陆授权签名
RequestBody
userId	是	Long	用户id

方式四 （POST）

参数	必选	类型	说明
RequestBody
showSub	否	int	是否显示用户学科;0:否；1:是;返回grades;subjects
showOrg	否	int	是否显示用户所有机构信息;0:否；1:是;返回relations
showStu	否	int	是否显示教师所教的学生;0:否；1:是;需要showOrg:1；返回students

HTTP 响应状态

200

data(showOrg:1;showStu:1)

relations(大学)

参数	必选	类型	说明
grade	是	string	学院
class	是	array	专业id数组;[1,2]

class

参数	必选	类型	说明
name	是	string	年级id
students	否	array	showStu:1;显示学生

students

参数	必选	类型	说明
username	是	string	用户帐号
userId	是	int	用户id

relations(小学，初中，高中，其他)

参数	必选	类型	说明
grade	是	string	年级id
class	是	array	班级id数组;[1,2]

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":22，"token":"#########"} http://api.sewise.com/v1/user/userInfo
Response
{"status":200,"data":{"userId":"22","mobile":"18666666776","email":"123456@163.com",
"emailVerify":"1","userType":"1","rank":"0","creationDate":"2016-07-06 10:34:54","accountStatus":"1","lastLogin":"2016-07-19 11:01:40","isDelete":"N","fId":"2",
"nickName":"\u5f20\u4e09",
"address":"\u6df1\u5733\u5e02\u77fd\u4f1f\u667a\u79d1\u6280
\u6709\u9650\u516c\u53f8","bindValue":"8837263462364"}}

接口示例(教师)

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":22，"token":"#########"，"showOrg":1,"showStu"} http://api.sewise.com/v1/user/userInfo
Response
{"status":200,"data":{"userId":"669","username":"laoshi99","mobile":"","userType":"2","creationDate":"2017-05-11 09:17:39","accountStatus":"0","lastLogin":"2017-05-11 09:18:04","isDelete":"N","fId":"665","nickName":"明老师","address":null,"bindValue":null,"avatar":null,"sex":"0","organName":"燕山大学","organkind":"4","relations":[{"college":"机械学院","id":"4","disciplines":[{"name":"机械专业","id":"6","grades":[{"grade":"大一","id":"7","class":[{"name":"1班","id":"7","students":[{"username":"xuesheng3","userId":"654"}]}]}]}]},{"college":"外语学院","id":"1","disciplines":[{"name":"日语专业","id":"3","grades":[{"grade":"大二","id":"4","class":[{"name":"1班","id":"4","students":[{"username":"xuesheng1","userId":"652"}]}]}]}]}]}}

1.5 编辑用户基本信息

接口地址

/v1/user/edit

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数	必选	类型	说明
PathParam
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
username	否	String	用户名
mobile	否	String	要更改成的手机号码
userType	否	int	用户类型：管理用户，普通用户
avatar	否	String	头像
email	否	String	邮箱
emailVerify	否	int	邮件验证状态:0未验证，1已验证
accountStatus	否	int	用户的状态，如待激活，禁用
lastLogin	否	String	最后登录时间
.....

例如： /v1/user/edit?access_token={access_token}
或：

参数	必选	类型	说明
RequestHeader
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
mobile	否	String	要更改成的手机号码
email	否	String	邮箱
emailVerify	否	int	邮件验证状态:0未验证，1已验证
userType	否	int	用户类型：管理用户，普通用户
accountStatus	否	int	用户的状态，如待激活，禁用
lastLogin	否	String	最后登录时间
.....

方式二 （POST）

参数	必选	类型	说明
RequestHeader
token	是	String	管理员/内部调用授权签名
RequestBody
userId	是	Long	用户id
mobile	否	String	要更改成的手机号码
email	否	String	邮箱
emailVerify	否	int	邮件验证状态:0未验证，1已验证
userType	否	int	用户类型：管理用户，普通用户
accountStatus	否	int	用户的状态，如待激活，禁用
lastLogin	否	String	最后登录时间
.....

方式三 （POST）

参数	必选	类型	说明
RequestHeader
unLoginToken	是	String	免登陆授权签名
RequestBody
userId	是	Long	用户id
mobile	否	String	要更改成的手机号码
email	否	String	邮箱
emailVerify	否	int	邮件验证状态:0未验证，1已验证
userType	否	int	用户类型：管理用户，普通用户
accountStatus	否	int	用户的状态，如待激活，禁用
lastLogin	否	String	最后登录时间
.....

个人信息

参数	必选	类型	说明
userType	是	string/int	用户类型;1:学生,2:教师
nickName	是	int	用户真实名称
sex	是	int	用户性别;0:男，1：女

完善教师信息

参数	必选	类型	说明
organId	是	string/int	学校名称或学校id
organKind	是	int	机构分类;1小学，2初中，3高中，4大学，5其他
grades	否	array	年级信息
subjects	否	array	学科信息

grades(大学)

参数	必选	类型	说明
college	是	string	学院id
disciplines	是	array	专业id数组;[1,2]

grades(小学，初中，高中，其他)

参数	必选	类型	说明
grade	是	string	年级id
class	是	array	班级id数组;[1,2]

完善学生信息

参数	必选	类型	说明
organId	是	string/int	学校名称或学校id
collegeId	否	int	大学学院id
disciplineId	否	int	大学学院专业id
organKind	是	int	机构分类;1小学，2初中，3高中，4大学，5其他
year	否	int	入学年份
typeId	是	string	年级id
classId	是	string	班级id

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","mobile":"13424284710","email":"123456@163.com",“userType”:"1"，"token":"#########"} http://account.sewise.com/v1/user/edit
Response
{"status":200,"message":["\u4fee\u6539\u6210\u529f"]}

1.6 验证已登录用户密码

接口地址

/v1/user/authPass

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数	必选	类型	说明
PathParam
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
password	是	String	帐户密码

例如： /v1/user/authPass?access_token={access_token}
或：

参数	必选	类型	说明
RequestHeader
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
password	是	String	帐户密码

方式二 （POST）

参数	必选	类型	说明
RequestHeader
token	是	String	管理员/内部调用授权签名
RequestBody
userId	是	Long	用户id
password	是	String	帐户密码

方式三 （POST）

参数	必选	类型	说明
RequestHeader
unLoginToken	是	String	免登陆授权签名
RequestBody
userId	是	Long	用户id
password	是	String	帐户密码

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","password":"123456"，"token":"#########"} http://account.sewise.com/v1/user/authPass
Response
{"status":200,"message":["\u5bc6\u7801\u6b63\u786e"]}

1.7 重置密码

接口地址

/v1/user/reset

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数	必选	类型	说明
PathParam
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
password	是	String	帐户密码

例如： /v1/user/reset?access_token={access_token}
或：

参数	必选	类型	说明
RequestHeader
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
password	是	String	帐户密码

方式二 （POST）

参数	必选	类型	说明
RequestHeader
token	是	String	管理员/内部调用授权签名
RequestBody
userId	是	Long	用户id
password	是	String	帐户密码

方式三 （POST）

参数	必选	类型	说明
RequestHeader
unLoginToken	是	String	免登陆授权签名
RequestBody
userId	是	Long	用户id
password	是	String	帐户密码

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","password":"123456"，"token":"#########"} http://account.sewise.com/v1/user/reset
Response
{"status":200,"message":["\u5bc6\u7801\u91cd\u7f6e\u6210\u529f"]}

1.8 登录记录

接口地址

/v1/user/record

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数	必选	类型	说明
PathParam
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
page	否	int	页数
pageSize	否	int	页码
order	否	String	排序

例如： /v1/user/record?access_token={access_token}
或：

参数	必选	类型	说明
RequestHeader
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
page	否	int	页数
pageSize	否	int	页码
order	否	String	排序

方式二 （POST）

参数	必选	类型	说明
RequestHeader
token	是	String	管理员/内部调用授权签名
RequestBody
userId	是	Long	用户uid
page	否	int	页数
pageSize	否	int	页码
order	否	String	排序

方式三 （POST）

参数	必选	类型	说明
RequestHeader
unLoginToken	是	String	免登陆授权签名
RequestBody
userId	是	Long	用户uid
page	否	int	页数
pageSize	否	int	页码
order	否	String	排序

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"32"，"token":"#########"，"page":"1","pageSize":"20","order":"aId DESC"} http://api.sewise.com/v1/user/record
Response
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":1,"record":[{"area":"\u5e7f\u4e1c \u6df1\u5733","ip":"127.0.0.1","loginDate":"2016-07-18 13:46:50"}]}}

1.9 手机号是否存在

接口地址

/v1/user/checkMobile

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数	必选	类型	说明
PathParam
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
mobile	是	int	手机号

例如： /v1/user/checkMobile?access_token={access_token}
或：

参数	必选	类型	说明
RequestHeader
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
mobile	是	int	手机号

方式二 （POST）

参数	必选	类型	说明
RequestHeader
token	是	String	管理员/内部调用授权签名
RequestBody
mobile	是	int	手机号

方式三 （POST）

参数	必选	类型	说明
RequestHeader
unLoginToken	是	String	免登陆授权签名
RequestBody
mobile	是	int	手机号

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"32"，"token":"#########"} http://api.sewise.com/v1/user/checkMobile
Response
{"status":200,"data":{"userId":"16"}}

1.10 用户名是否存在

接口地址

/v1/user/checkUsername

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
username	是	string	用户名

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"username":"xiaoming"} http://api.sewise.com/v1/user/checkUsername
Response
{"status":200,"data":{"userId":"16"}}

1.11 修改头像

接口地址

/v1/user/avatar

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
userId	是	int	用户id
img	是	file	用户头像

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:multipart/form-data" -d {"userId":"1"} http://api.sewise.com/v1/user/avatar
Response
{"status":200,"data":{"userId":"16"}}

1.12 大学教师添加专业

接口地址

/v1/user/addSubject

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
userId	是	int	用户id
name	是	string	专业名称

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:multipart/form-data" -d {"userId":"1"} http://api.sewise.com/v1/user/addSubject
Response
{"status":200,"data":{"userId":"16"，"Id":"16","name":"专业"}}

1.13 第三方登录

接口地址

/sdk/OAuthLogin/{type}

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
type	是	string	第三方平台类型; 微信：wechat，QQ：qq
openid	是	string	第三方平台唯一用户标识

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:multipart/form-data" -d {"userId":"1"} http://api.sewise.com/v1/sdk/OAuthLogin/wechat
Response
{"status":200,"data":{"userId":"2","userType":"1","access_token":"w4GJutv2YWdOwuof5zJgH5aCwvI7cRFbsb8q0EG8","expire":"2018-08-31 18:21:20","userinfo":{"userId":"2","username":"wechat_18080118164574","mobile":null,"userType":"1","vip":"0","creationDate":"2018-08-01 18:16:45","accountStatus":"1","expertRank":"0","lastLogin":"2018-08-01 18:16:45","isDelete":"N","from":null,"expireDate":null,"access_token":"w4GJutv2YWdOwuof5zJgH5aCwvI7cRFbsb8q0EG8"}}}

2.消息中心

2.1 短信发送

接口地址

/v1/sms/send

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestHeader
token	是	String	管理员/内部调用授权签名
RequestBody
moible	是	String	手机号码

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/sms/send
Response
{"status":200,"message":"\u53d1\u9001\u6210\u529f","data":{"mobile":"13888888888","code":"389123"}}

2.2 短信验证

接口地址

/v1/sms/codeCheck

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
moible	是	String	手机号码
code	是	String	验证码

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"code":"338883"} http://api.sewise.com/v1/sms/codeCheck
Response
{"status":200,"message":"\u53d1\u9001\u6210\u529f","access_token":"xxxxx"}

3.区域、学校、重名检索修改登录名中心

3.1 获取区域

接口地址

/v1/area/region

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
code	是	int	区域编码（获取省级的code默认为0）

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/area/region
Response
{"status": 200,"data": [{"aId": "110000","areaname": "北京","level": "1","pinyin": "beijing","py": null},{"aId":"120000","areaname": "天津","level": "1","pinyin": "tianjin","py": null},}

3.2 创建机构（如学校）

接口地址

/v1/create/organization

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
province	是	int	省级编码
city	是	int	市级编码
area	是	int	区级编码
organ_name	是	int	机构名称
organ_type	否	int	机构类型（默认为1：小学）
organ_class	否	int	机构下班级数（默认为0）

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/create/organization
Response
{
"status": 200,
"data": "创建成功!"
}

3.3 获取机构（如学校）

接口地址

/v1/get/organization

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
province	否	int	省级编码
city	否	int	市级编码
area	否	int	区级编码
organ_kind	否	int	学校类型；1小学；2初中；3高中；4大学；5其他

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://vtest.sewise.com.cn/v1/get/organization
Response
{"status": 200,"data": [{"organ_id": "1","organ_name": "东城第一中学"，"organ_kind":"1"},{"organ_id":"5","organ_name": "东城第二中学"，"organ_kind":"1"},}

3.3.1 获取机构下老师

接口地址

/v1/api/personlist

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
organId	是	int	机构id

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"organId":"1"} http://vtest.sewise.com.cn/api/v1/api/personlist
Response
{"status":200,"data":{"record":[{"userId":"711","accountStatus":"0","userName":"zygbb","nickName":"666","sex":"0","nodes":null}]}}

3.4 获取与用户有关的区域学校和虚拟学校库

接口地址

/v1/get/virtualSchool

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
province	是	int	省级编码
city	是	int	市级编码
area	是	int	区级编码
uid	是	int	用户id

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/get/virtualSchool
Response
{
"status": 200,
"data": [
{
"organ_id": "1",
"province": "110000",
"city": "110100",
"area": "110101",
"organ_name": "东城第一中学",
"organ_type": "2",
"organ_class": "20",
"creation_date": "2017-03-08 06:40:45"
},
{
"organ_id": "6",
"province": "110000",
"city": "110100",
"area": "110101",
"organ_name": "东城第三小学",
"organ_type": "1",
"organ_class": "12",
"creation_date": "2017-03-08 10:48:10"
},
{
"organ_name": "石井中学"
},
{
"organ_name": "人和三中"
},
{
"organ_name": "竹料第一中学"
},
{
"organ_name": "培正中学"
},
{
"organ_name": "嘉禾中学"
},
{
"organ_name": "天秀中学"
}
]
}

3.5 验证学生用户是否在学校所属的录播主机中

接口地址

/v1/verify/School

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
province	是	int	省级编码
city	是	int	市级编码
area	是	int	区级编码
organ_id	是	int	机构（学校）id
uid	是	int	用户id

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/verify/School
Response
{
"status": 200,
"data": {
"nId": "3",
"userId": "101",
"nodeId": "123465",
"nodeSn": "abcdfeff",
"nodeUsername": "南山小学微录播主机sd",
"verify": "0",
"creationDate": "2017-03-08 06:40:45"
}
}
或
{
"status": 404,
"data": "该学生用户不在学校所属的录播主机中"
}

3.6 重命名检索、检索不重名则更新用户名

接口地址

/v1/user/dupName

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
uid	是	int	用户id
nodeSn	是	string	主机节点sn码
username	是	string	输入的用户名

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/user/dupName
Response
{
"status": 200,
"data": "重命名成功!新用户名为：daming"
}
或
{
"status": 404,
"data": "新登录名已存在，请重新输入!"
}

3.7 机构（学校）模糊搜索

接口地址

/v1/search/school

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
q	是	string	搜索关键字

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/user/dupName
Response
{"status": 200,"data": [{"organ_id": "1","organ_name": "东城第一中学"},}

3.8 年级搜索

接口地址

/v1/get/grade

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
organId	是	string	学校id
collegeId	否	string	学校学院id
disId	否	string	学校学院专业id
typeKind	否	int	教室类型;1:正常教室，2：其他教室

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/get/grade
Response
{"status":200,"data":[{"Id":"18","name":"2017年","organId":"8","creationDate":"2017-04-19 11:12:33","grade":"2017","class":[{"Id":"7","name":"1班","organId":"8","typeId":"18","creationDate":"2017-04-19 11:12:33"},{"Id":"8","name":"2班","organId":"8","typeId":"18","creationDate":"2017-04-19 11:12:33"},{"Id":"9","name":"3班","organId":"8","typeId":"18","creationDate":"2017-04-19 11:12:33"},{"Id":"10","name":"4班","organId":"8","typeId":"18","creationDate":"2017-04-19 11:21:35"}]},{"Id":"19","name":"2018年","organId":"8","creationDate":"2017-04-19 11:22:04","grade":"2018","class":[{"Id":"11","name":"1班","organId":"8","typeId":"19","creationDate":"2017-04-19 11:22:04"},{"Id":"12","name":"2班","organId":"8","typeId":"19","creationDate":"2017-04-19 11:22:04"},{"Id":"13","name":"3班","organId":"8","typeId":"19","creationDate":"2017-04-19 11:22:04"},{"Id":"14","name":"4班","organId":"8","typeId":"19","creationDate":"2017-04-19 11:22:04"}]}]}

3.9 学院搜索

接口地址

/v1/get/college

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
organId	是	string	学校id

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://api.sewise.com/v1/get/college
Response
{"status":200,"data":[{"Id":"62","name":"计算机学院","pid":"0","organId":"56","creationDate":"2017-04-28 15:36:38","disciplines":[{"Id":"63","name":"多媒体专业","pid":"62","organId":"56","creationDate":"2017-04-28 15:36:38"}]}]}

3.9.2 学科接口

接口地址

/v1/area/subject

HTTP Content-Type / 请求方式

application/json
GET

请求参数

参数	必选	类型	说明
organKind	否	int	学校类型id

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/area/subject
Response
{"status":200,"data":[{"Id":"1","name":"\u8bed\u6587","code":"101"},{"Id":"2","name":"\u6570\u5b66","code":"102"},{"Id":"3","name":"\u82f1\u8bed","code":"103"},{"Id":"4","name":"\u7269\u7406","code":"104"},{"Id":"5","name":"\u5316\u5b66","code":"105"},{"Id":"6","name":"\u751f\u7269","code":"106"},{"Id":"7","name":"\u5730\u7406","code":"107"},{"Id":"8","name":"\u5386\u53f2","code":"108"},{"Id":"9","name":"\u653f\u6cbb","code":"109"}]}

3.10 大学学院名称检查是否存在

接口地址

/v1/manager/checkCollege

HTTP Content-Type / 请求方式

application/json
POST

请求参数

access_token 授权token

参数	必选	类型	说明
organId	是	int	学校id
college	是	string	学院名称

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/checkCollege?access_token
Response
{
"status": 200,
"message": "该学院名称未使用"
}

3.11 检查学生所在班级id

接口地址

/v1/api/checkClassId

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
userId	是	int	学生id

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/ /v1/api/checkClassId
Response
{
"status": 200,
"data": "62,63,64"
}

4.节点主机

4.1 我的主机列表

接口地址

/v1/node/myNodeList

HTTP Content-Type / 请求方式

application/json
GET

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	授权签名（用户登陆成功返回的access_token）

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"access_token":"xxxxxx"} http://api.sewise.com/v1/node/myNodeList
Response
{"status": 200,"data": {"total_page":1,"page":1,"pagesize":20,"total_record": 1,"record": [{"nodeId":"1","nodeSn":"1234567890","nodeUsername":"深圳南山实验小学"}],}}

5.录播主机信息同步

5.1 主机注册

接口地址

/v1/node/add

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
nodeSn	是	string	主机唯一标识码
province	是	string	所在省编号
city	是	string	所在市编号
area	是	string	所在地区编号
organId	是	string	所在学校id
nodeIp	是	string	所用主机ip
nodeType	是	int	所用主机类型
address	是	array	隶属信息
list	是	array	帐号列表

list

参数	必选	类型	说明
RequestBody
username	是	string	帐号名
role	是	string	帐号角色
phone	是	string	手机

address

参数	必选	类型	说明
RequestBody
province	是	string	所在省编号
city	是	string	所在城市
area	是	string	所在地区
kind	是	string	级别等级
school	是	string	学校信息
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	int	年级信息
class	是	array	班级信息

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"nodeSn":"xxxxxx"} http://api.sewise.com/v1/node/add
Response
{"status": 200,'data':[]}

5.2 主机帐号注册

接口地址

/v1/account/add

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
nodeSn	是	string	主机唯一标识码
list	是	array	帐号列表

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"nodeSn":"xxxxxx"} http://api.sewise.com/v1/account/add
Response
{"status": 200,'data':[]}

5.3 主机查询是否注册

接口地址

/v1/check/node

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
sn	是	string	主机唯一标识码
username	否	string	用户帐号

HTTP 响应状态

200

data

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"sn":"xxxxxx"} http://api.sewise.com/v1/check/node
Response
{
"status": 0,
"msg": "该主机已注册"
}

6.支付

6.1 微信统一下单（扫码支付模式二）

接口地址

/v1/wxpay/unifiedorder

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
orderName	是	string	订单名称
totalFee	是	int	标价金额
userId	否	string	用户信息id
deviceInfo	否	string	设备信息，如SN
ip	否	string	终端ip

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/wxpay/unifiedorder
Response
{"status":200,"message":"\u9a8c\u8bc1\u6210\u529f","data":{"code_url":"weixin:\/\/wxpay\/bizpayurl?pr=NaTVwh7"}}

6.2 生成二维码图片

接口地址

/v1/wxpay/qrcode

HTTP Content-Type / 请求方式

application/json
GET/POST

请求参数

参数	必选	类型	说明
RequestBody
code_url	是	string	二维码链接code

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"code_url":"xxxxxx"} http://api.sewise.com/v1/wxpay/qrcode
Response
{渲染图片，该请求链接直接放H5 img标签的src值}

7.运营平台

7.1 用户管理

7.1.1 用户列表

接口地址

/v1/manager/stuList

HTTP Content-Type / 请求方式

application/json
GET

请求参数

参数	必选	类型	说明
RequestBody
page	是	int	分页
pageSize	是	int	分页数
order	否	string	排序

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/stuList
Response
{"status":200,"data":{"total_page":2,"page":1,"pagesize":20,"total_record":29,"record":[{"userId":"35","username":"wangyuanlong","mobile":"","userType":"1","creationDate":"2017-03-16 19:49:12","accountStatus":"1","lastLogin":"2017-03-16 19:49:12","isDelete":"N"}]}}

7.1.2 用户状态

接口地址

/v1/manager/editStuStatus

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
userId	是	int	学生id
status	是	int	状态;1正常;-1禁用

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/editStuStatus
Response
{"status":200,"data":{"userId":"3","username":"jacky1","mobile":"","userType":"1","creationDate":"2017-03-16 19:49:12","accountStatus":"1","lastLogin":"2017-04-19 10:47:12","isDelete":"N"}}

7.1.3 删除用户

接口地址

/v1/manager/delStu

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
userId	是	int	学生id

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/delStu
Response
{"status":200,"data":{"userId":"3","username":"jacky1","mobile":"","userType":"1","creationDate":"2017-03-16 19:49:12","accountStatus":"1","lastLogin":"2017-04-19 10:47:12","isDelete":"D"}}

7.1.4 修改用户密码

接口地址

/v1/manager/pwdStu

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
userId	是	int	学生id
password	是	string	学生password

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/pwdStu
Response
{"status":200,"data":{"userId":"3","username":"jacky1","mobile":"","userType":"1","creationDate":"2017-03-16 19:49:12","accountStatus":"1","lastLogin":"2017-04-19 10:52:15","isDelete":"N"}}

7.1.5 添加学校管理员

接口地址

/v1/manager/addMaster

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
username	是	int	帐号名
nickname	是	string	昵称
organId	是	int	学校id

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/addMaster
Response
{"status":200,"data":{"userId":"3","username":"jacky1","mobile":"","userType":"1","creationDate":"2017-03-16 19:49:12","accountStatus":"1","lastLogin":"2017-04-19 10:52:15","isDelete":"N"}}

7.2 学校管理

7.2.1 学校列表

接口地址

/v1/manager/orgList

HTTP Content-Type / 请求方式

application/json
GET

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/orgList
Response
{"status":200,"data":{"total_page":1,"page":1,"pagesize":20,"total_record":2,"record":[{"organ_id":"2","province":"130000","city":"130200","area":"130204","organ_name":"444","organ_kind":"2","creation_date":"2017-04-17 15:24:01","provinceName":"河北省","cityName":"唐山市","areaName":"古冶区","organKindName":"初中","classNum":1},{"organ_id":"1","province":"110000","city":"110100","area":"110101","organ_name":"罗湖小学","organ_kind":"2","creation_date":"2017-03-16 19:49:12","provinceName":"北京","cityName":"北京市","areaName":"东城区","organKindName":"初中","classNum":2}]}}

7.2.2 编辑学校

接口地址

/v1/manager/editOrg

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
organId	是	int	学校id

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/editOrg
Response
{"status":200,"data":{"organ_id":"1","province":"110000","city":"110100","area":"110101","organ_name":"罗湖小学","organ_kind":"2","creation_date":"2017-03-16 19:49:12"}}

7.2.3 添加学校

接口地址

/v1/manager/addOrg

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
province	是	int	省份
city	是	int	城市
area	是	int	地区
organ_name	是	string	学校名称
organ_kind	是	int	学校类型
grades	是	json	年级信息

grades(小学；初中；高中；其他)

参数	必选	类型	说明
RequestBody
grade	是	string	年级名称；如一年级
class	是	array	班级名称；如['1班','2班']

grades(大学学院)

参数	必选	类型	说明
RequestBody
college	是	string	学院名称
disciplines	是	string	学院下级列表

grades disciplines(学院专业)

参数	必选	类型	说明
RequestBody
discipline	是	string	专业名称
list	是	string	学院下级列表

grades discipline list(学院专业班级)

参数	必选	类型	说明
RequestBody
grade	是	string	年级名称；如一年级
class	是	array	班级名称；如['1班','2班']

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/addOrg
Response
{"status":200,"data":{"organId":"1","province":"110000","city":"110100","area":"110101","organ_name":"罗湖小学2","organ_kind":"2"}}

7.2.4 保存学校

接口地址

/v1/manager/saveOrg

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
organId	是	int	学校id
province	是	int	省份
city	是	int	城市
area	是	int	地区
organ_name	是	string	学校名称
organ_kind	是	int	学校类型
grades	是	json	年级信息

grades(小学；初中；高中；其他)

参数	必选	类型	说明
RequestBody
grade	是	string	年级名称；如一年级
class	是	array	班级名称；新增如['1班','2班']；编辑[{'class_id':1,'class_name':'3班'}]

grades(大学学院)

参数	必选	类型	说明
RequestBody
college	是	string	学院名称
disciplines	是	string	学院下级列表

grades disciplines(学院专业)

参数	必选	类型	说明
RequestBody
discipline	是	string	专业名称
list	是	string	学院下级列表

grades discipline list(学院专业班级)

参数	必选	类型	说明
RequestBody
grade	是	string	年级名称；如一年级
class	是	array	班级名称；新增如['1班','2班']；编辑[{'class_id':1,'class_name':'3班'}]

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/addOrg
Response
{"status":200,"data":{"organId":"1","province":"110000","city":"110100","area":"110101","organ_name":"罗湖小学2","organ_kind":"2","grades": "[{'year':'2017年','class'=>'3'}]"}}

7.2.5 编辑学校

接口地址

/v1/manager/editOrg

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
organId	是	int	学校id

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/editOrg
Response
{"status":200,"data":{"organ_id":"8","province":"110000","city":"110100","area":"110101","organ_name":"罗湖小学6","organ_kind":"2","creation_date":"2017-04-19 11:12:33","grades":[{"year":"2018","class":4}]}}

7.2.6 删除学校

接口地址

/v1/manager/delOrg

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
organId	是	int	学校id

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/delOrg
Response
{"status":200,"data":{"organ_id":"8","province":"110000","city":"110100","area":"110101","organ_name":"罗湖小学6","organ_kind":"2","creation_date":"2017-04-19 11:12:33","grades":[{"year":"2018","class":4}]}}

7.2.7 编辑时删除学校下级节点

接口地址

/v1/manager/delOrgNode

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数(删除班级)

参数	必选	类型	说明
RequestBody
organId	是	int	学校id
classId	是	int	学校班级id

请求参数(删除年级)

参数	必选	类型	说明
RequestBody
organId	是	int	学校id
gradeId	是	int	学校年级id

请求参数(删除专业)

参数	必选	类型	说明
RequestBody
organId	是	int	学校id
disId	是	int	学校专业id

请求参数(删除学院)

参数	必选	类型	说明
RequestBody
organId	是	int	学校id
collegeId	是	int	学校学院id

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/delOrgNode
Response
{"status":200,"data":{"nodeId":"3","nodeName":"罗湖小学31","nodeSn":"SP05AV100034121A","nodeSecret":"61726496d0b0222c75867f3dfc8b9adf","nodeIp":"127.0.0.1","remoteIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","nodeBind":"-1","userId":"0","nodeType":"1","province":"110000","city":"110100","area":"110101","organId":"10","organKind":"1","typeId":"","classId":"","creationDate":"2017-04-19 10:12:55","modifiedDate":"2017-04-19 12:13:52","isDelete":"N","gateway":null}}

7.3 主机管理

7.3.1 主机列表

接口地址

/v1/manager/nodeList

HTTP Content-Type / 请求方式

application/json
GET

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/orgList
Response
{"status":200,"data":{"total_page":1,"page":1,"pagesize":20,"total_record":3,"record":[{"organId":"1","nodeSn":"SP05AV100034121A","nodeName":"罗湖小学","nodeIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","province":"110000","city":"110100","area":"110101","organKind":"1","typeId":null,"classId":null,"modifiedDate":"2017-04-19 10:58:50","admin":"master1","adminid":"40","online":0,"provinceName":"北京","cityName":"北京市","areaName":"东城区","orgYear":"","orgClassName":"","organKindName":"小学","orgType":"","orgClass":""},{"organId":"2","nodeSn":"SP05AV100000937A","nodeName":"444","nodeIp":"127.0.0.7","nodeHost":"http://SP05AV100000937A.v.sewise.com","province":"130000","city":"130200","area":"130204","organKind":"2","typeId":"2","classId":"3","modifiedDate":"2017-04-17 15:26:42","admin":"luozhaofeng","adminid":"5","online":1,"provinceName":"河北省","cityName":"唐山市","areaName":"古冶区","orgYear":"二年年","orgClassName":"","organKindName":"初中","orgType":"二年级","orgClass":"3班"},{"organId":"1","nodeSn":"SP05AV100034120A","nodeName":"罗湖小学","nodeIp":"192.168.1.101","nodeHost":"http://SP05AV100033108A.mqtt.sewise.com","province":"130000","city":"130200","area":"130204","organKind":"1","typeId":"13","classId":"1","modifiedDate":"2017-04-19 10:58:50","admin":"master1","adminid":"40","online":0,"provinceName":"河北省","cityName":"唐山市","areaName":"古冶区","orgYear":"2015年","orgClassName":"二年级","organKindName":"小学","orgType":"2015级","orgClass":"1"}]}}

7.3.2 编辑主机

接口地址

/v1/manager/editNode

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
nodeId	是	int	主机id

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/editNode
Response
{"status":200,"data":{"total_page":1,"page":1,"pagesize":20,"total_record":3,"record":[{"organId":"1","nodeSn":"SP05AV100034121A","nodeName":"罗湖小学","nodeIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","province":"110000","city":"110100","area":"110101","organKind":"1","typeId":null,"classId":null,"modifiedDate":"2017-04-19 10:58:50","admin":"master1","adminid":"40","online":0,"provinceName":"北京","cityName":"北京市","areaName":"东城区","orgYear":"","orgClassName":"","organKindName":"小学","orgType":"","orgClass":""},{"organId":"2","nodeSn":"SP05AV100000937A","nodeName":"444","nodeIp":"127.0.0.7","nodeHost":"http://SP05AV100000937A.v.sewise.com","province":"130000","city":"130200","area":"130204","organKind":"2","typeId":"2","classId":"3","modifiedDate":"2017-04-17 15:26:42","admin":"luozhaofeng","adminid":"5","online":1,"provinceName":"河北省","cityName":"唐山市","areaName":"古冶区","orgYear":"二年年","orgClassName":"","organKindName":"初中","orgType":"二年级","orgClass":"3班"},{"organId":"1","nodeSn":"SP05AV100034120A","nodeName":"罗湖小学","nodeIp":"192.168.1.101","nodeHost":"http://SP05AV100033108A.mqtt.sewise.com","province":"130000","city":"130200","area":"130204","organKind":"1","typeId":"13","classId":"1","modifiedDate":"2017-04-19 10:58:50","admin":"master1","adminid":"40","online":0,"provinceName":"河北省","cityName":"唐山市","areaName":"古冶区","orgYear":"2015年","orgClassName":"二年级","organKindName":"小学","orgType":"2015级","orgClass":"1"}]}}

7.3.3 保存主机

接口地址

/v1/manager/saveNode

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
nodeId	是	int	主机id
nodeSn	是	int	主机sn
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
organId	是	string/int	学校名称或学校id
address	是	json	主机信息

address

参数	必选	类型	说明
RequestBody
kind	是	int	学校类型
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
school	是	string	学校名称

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/saveNode
Response
{"status":200,"data":{"nodeId":"3","nodeName":"罗湖小学31","nodeSn":"SP05AV100034121A","nodeSecret":"61726496d0b0222c75867f3dfc8b9adf","nodeIp":"127.0.0.1","remoteIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","nodeBind":"-1","userId":"0","nodeType":"1","province":"110000","city":"110100","area":"110101","organId":"10","organKind":"1","typeId":"","classId":"","creationDate":"2017-04-19 10:12:55","modifiedDate":"2017-04-19 12:13:52","isDelete":"N","gateway":null}}

7.3.3 添加主机

接口地址

/v1/manager/addNode

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
nodeSn	是	int	主机sn
nodeType	是	int	类型：1.普通（默认），2.内容商，3.开发商，4.平台
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
organId	是	string/int	学校名称或学校id
address	是	json	主机信息

address

参数	必选	类型	说明
RequestBody
kind	是	int	学校类型
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
school	是	string	学校名称

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/addNode
Response
{"status":200,"data":{"nodeId":"3","nodeName":"罗湖小学31","nodeSn":"SP05AV100034121A","nodeSecret":"61726496d0b0222c75867f3dfc8b9adf","nodeIp":"127.0.0.1","remoteIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","nodeBind":"-1","userId":"0","nodeType":"1","province":"110000","city":"110100","area":"110101","organId":"10","organKind":"1","typeId":"","classId":"","creationDate":"2017-04-19 10:12:55","modifiedDate":"2017-04-19 12:13:52","isDelete":"N","gateway":null}}

7.4 统计管理

7.4.1 主机统计

接口地址

/v1/manager/nodeCount

HTTP Content-Type / 请求方式

application/json
GET

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/nodeCount
Response
{
"status": 200,
"data": {
"reg": 1,
"online": 57,
"today_klg": 90,
"klg_total": 90
}
}

7.4.2 学校统计

接口地址

/v1/manager/schoolCount

HTTP Content-Type / 请求方式

application/json
GET

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/schoolCount
Response
{
"status": 200,
"data": {
"school": 9,
"student": 28,
"teacher": 6,
"machine": 3
}
}

7.4.3 用户统计

接口地址

/v1/manager/stuCount

HTTP Content-Type / 请求方式

application/json
GET

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/stuCount
Response
{
"status": 200,
"data": {
"today_learn_swl": 18,
"total_learn_swl": 18,
"total_question": 54,
"today_question": 54,
"today_online_time": 98622,
"total_online_time": 98622,
"today_klg": 90,
"klg_total": 90
}
}

7.5 学科管理

7.5.1 学科列表

接口地址

/v1/manager/subjectList

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
organKind	int	学科类别;1:小学；2初中；3高中；4大学学科；5大学公共基础

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/subjectList
Response
{"status":200,"data":{"total_page":1,"page":1,"pagesize":20,"total_record":8,"record":[{"Id":"8","name":"历史","code":"108","organKind":"1","isDelete":"N"},{"Id":"7","name":"地理","code":"107","organKind":"1","isDelete":"N"},{"Id":"6","name":"生物","code":"106","organKind":"1","isDelete":"N"},{"Id":"5","name":"化学","code":"105","organKind":"1","isDelete":"N"},{"Id":"4","name":"物理","code":"104","organKind":"1","isDelete":"N"},{"Id":"3","name":"英语","code":"103","organKind":"1","isDelete":"N"},{"Id":"2","name":"数学","code":"102","organKind":"1","isDelete":"N"},{"Id":"1","name":"语文","code":"101","organKind":"1","isDelete":"N"}]}}

7.5.2 请求学科信息

接口地址

/v1/manager/editSub

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
subjectId	int	学科id

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/editSub
Response
{"status":200,"data":{"Id":"1","name":"语文","code":"101","organKind":"1","isDelete":"N"}}

7.5.3 保存学科信息

接口地址

/v1/manager/saveSub

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
subjectId	int	学科id
organKind	int	学科类别;1:小学；2初中；3高中；4大学学科；5大学公共基础
name	string	学科名称

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/saveSub
Response
{"status":200,"data":{"Id":"1","name":"语文","code":"101","organKind":"1","isDelete":"N"}}

7.5.4 创建学科

接口地址

/v1/manager/addSub

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
organKind	int	学科类别;1:小学；2初中；3高中；4大学学科；5大学公共基础
name	string	学科名称

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/addSub
Response
{"status":200,"data":{"Id":"1","name":"语文","code":"101","organKind":"1","isDelete":"N"}}

7.5.5 删除学科

接口地址

/v1/manager/delSub

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
subjectId	int	学科id

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/manager/delSub
Response
{"status":200,"data":{"Id":"1","name":"语文","code":"101","organKind":"1","isDelete":"N"}}

8 学校管理员管理

8.1 主机管理

8.1.1 绑定主机

接口地址

/v1/school/addnode

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
nodeSn	是	int	主机sn
nodeType	是	int	类型：1.普通（默认），2.内容商，3.开发商，4.平台
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
organId	是	string/int	学校名称或学校id
address	是	json	主机信息

address

参数	必选	类型	说明
RequestBody
kind	是	int	学校类型
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
school	是	string	学校名称

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/school/addnode
Response
{"status":200,"data":{"nodeId":"3","nodeName":"罗湖小学31","nodeSn":"SP05AV100034121A","nodeSecret":"61726496d0b0222c75867f3dfc8b9adf","nodeIp":"127.0.0.1","remoteIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","nodeBind":"-1","userId":"0","nodeType":"1","province":"110000","city":"110100","area":"110101","organId":"10","organKind":"1","typeId":"","classId":"","creationDate":"2017-04-19 10:12:55","modifiedDate":"2017-04-19 12:13:52","isDelete":"N","gateway":null}}

8.1.2 解绑主机

接口地址

/v1/school/unbindnode

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
nodeSn	是	int	主机sn

address

参数	必选	类型	说明
RequestBody
kind	是	int	学校类型
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
school	是	string	学校名称

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/school/unbindnode
Response
{"status":200,"data":{"nodeId":"3","nodeName":"罗湖小学31","nodeSn":"SP05AV100034121A","nodeSecret":"61726496d0b0222c75867f3dfc8b9adf","nodeIp":"127.0.0.1","remoteIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","nodeBind":"-1","userId":"0","nodeType":"1","province":"110000","city":"110100","area":"110101","organId":"10","organKind":"1","typeId":"","classId":"","creationDate":"2017-04-19 10:12:55","modifiedDate":"2017-04-19 12:13:52","isDelete":"N","gateway":null}}

8.1.3 获取主机信息

接口地址

/v1/school/editnode

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
nodeId	是	int	主机sn

请求参数

参数	必选	类型	说明
RequestBody
nodeSn	是	int	主机sn

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/school/editnode
Response
{"status":200,"data":{"nodeId":"3","nodeName":"罗湖小学31","nodeSn":"SP05AV100034121A","nodeSecret":"61726496d0b0222c75867f3dfc8b9adf","nodeIp":"127.0.0.1","remoteIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","nodeBind":"-1","userId":"0","nodeType":"1","province":"110000","city":"110100","area":"110101","organId":"10","organKind":"1","typeId":"","classId":"","creationDate":"2017-04-19 10:12:55","modifiedDate":"2017-04-19 12:13:52","isDelete":"N","gateway":null}}

8.1.4 保存主机信息

接口地址

/v1/school/savenode

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
nodeId	是	int	主机id
nodeSn	是	int	主机sn
nodeType	是	int	类型：1.普通（默认），2.内容商，3.开发商，4.平台
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
organId	是	string/int	学校名称或学校id
address	是	json	主机信息

address

参数	必选	类型	说明
RequestBody
kind	是	int	学校类型
province	是	int	省份
city	是	int	城市
area	是	int	地区
typekind	是	string	教室类别；1为班级教室;2为其他教室
grade	是	string	年级
class	是	string	班级
school	是	string	学校名称

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/school/savenode
Response
{"status":200,"data":{"nodeId":"3","nodeName":"罗湖小学31","nodeSn":"SP05AV100034121A","nodeSecret":"61726496d0b0222c75867f3dfc8b9adf","nodeIp":"127.0.0.1","remoteIp":"127.0.0.1","nodeHost":"http://SP05AV100034121A.v.sewise.com","nodeBind":"-1","userId":"0","nodeType":"1","province":"110000","city":"110100","area":"110101","organId":"10","organKind":"1","typeId":"","classId":"","creationDate":"2017-04-19 10:12:55","modifiedDate":"2017-04-19 12:13:52","isDelete":"N","gateway":null}}

8.1.5 院系

接口地址

/v1/school/collegeList

HTTP Content-Type / 请求方式

application/json
POST

HTTP 响应状态

200

请求参数

参数	必选	类型	说明
RequestBody
organId	是	int	机构id

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"orderName":"xxxxxx",..} http://api.sewise.com/v1/school/collegeList
Response
{"status":200,"list":{"total_page":1,"page":1,"pagesize":20,"total_record":3,"record":[{"school":"长春职业技术学院工程分院","province":"110000","city":"110100","area":"110101","provinceName":"北京","cityName":"北京市","areaName":"东城区","student":28,"teacher":5,"list":[{"name":"环境专业","school":"长春职业技术学院工程分院环境专业","province":"110000","city":"110100","area":"110101","provinceName":"北京","cityName":"北京市","areaName":"东城区","student":"0","teacher":"0"},{"name":"数控专业","school":"长春职业技术学院工程分院数控专业","province":"130000","city":"130200","area":"130204","provinceName":"河北省","cityName":"唐山市","areaName":"古冶区","student":"23","teacher":"3"},{"name":"机电专业","school":"长春职业技术学院工程分院机电专业","province":"110000","city":"110100","area":"110101","provinceName":"北京","cityName":"北京市","areaName":"东城区","student":"5","teacher":"2"}]}]}}

8.1.6 获取机构主机列表

接口地址

/v1/school/nodeList

HTTP Content-Type / 请求方式

application/json
GET

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
page	否	int	页数
pageSize	否	int	页码
order	否	String	排序
nodeSn	否	String	主机sn(搜索)

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"access_token":"xxxxxx"} http://api.sewise.com/v1/school/nodeList
Response
{"status":200,"data":{"total_page":1,"page":1,"pagesize":20,"total_record":2,"record":[{"nodeSn":"SP05AV100000309B","nodeName":"\u6df1\u5733\u5927\u5b662","nodeIp":"113.58.32.152","province":"440000","city":"440300","area":"440305","organKind":"3","typeId":"4","classId":"4","modifiedDate":"2017-03-07 20:41:13","provinceName":"\u5e7f\u4e1c\u7701","cityName":"\u6df1\u5733\u5e02","areaName":"\u5357\u5c71\u533a","organKindName":"\u9ad8\u4e2d","orgType":"2013\u7ea7","orgClass":"1503\u73ed"},{"nodeSn":"SP05AV100000309A","nodeName":"\u6df1\u5733\u5927\u5b661","nodeIp":"113.58.32.151","province":"440000","city":"440300","area":"440305","organKind":"3","typeId":"3","classId":"3","modifiedDate":"2017-03-07 20:41:13","provinceName":"\u5e7f\u4e1c\u7701","cityName":"\u6df1\u5733\u5e02","areaName":"\u5357\u5c71\u533a","organKindName":"\u9ad8\u4e2d","orgType":"2015\u7ea7","orgClass":"1701\u73ed"}]}}

8.1.7 用户（学生/老师）列表

接口地址

/v1/school/personList/{userType}

HTTP Content-Type / 请求方式

application/json
GET/POST

请求参数

参数	必选	类型	说明
PathParam
userType	是	String	用户类型：1.学生 2.老师
access_token	是	String	授权签名（用户登陆成功返回的access_token）
RequestBody
page	否	int	页数
pageSize	否	int	页码
order	否	String	排序
username	否	String	用户昵称（搜索）

学生
k12

大学

老师
k12

大学

HTTP 响应状态

200

教师