[关闭]
@sewise-dev 2017-10-30T10:04:12.000000Z 字数 7237 阅读 594

微录播区域级接口文档

区域级 微录播


更新历史

编号 版本 说明 作者 日期
1 v1.0 1.创建文档 Seven 2017-10-30


目录


【备注】

1. 全局返回码说明

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

返回码 说明
-1 系统繁忙,此时请开发者稍候再试
0 请求失败
1 请求成功
200 响应成功
403 禁止访问
404 异常错误
500 数据验证错误
40001 不合法的凭证,或者access_token无效。
40004 不合法请求

HTTP请求状态返回格式

返回字段 字段类型 说明
status Integer 请求返回码(详细请见状态表)
message String 返回描述
data Array 返回结果

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


1.区域级管理

1.1 获取机构列表

接口地址

/v1/regional/orgList

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数
参数 必选 类型 说明
RequestBody
access_token String 用户授权签名
q int 搜索关键字
order string 排序
page int 页数
pageSize int 页码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/regional/orgList?access_token=xxx
Response
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"5","total_record":4,"record":[{"organ_id":"1","province":"440000","city":"440300","area":"440305","organ_name":"\u77fd\u4f1f\u667a\u5b9e\u9a8c\u5c0f\u5b66","organ_kind":"1","creation_date":"2017-06-27 10:05:55"},{"organ_id":"18","province":"440000","city":"440300","area":"440305","organ_name":"\u77fd\u4f1f\u667a\u5927\u5b66","organ_kind":"4","creation_date":"2017-07-26 11:28:01"},{"organ_id":"26","province":"440000","city":"440300","area":"440305","organ_name":"\u77fd\u4f1f\u667a\u7814\u7a76\u9662","organ_kind":"4","creation_date":"2017-08-14 15:12:56"},{"organ_id":"29","province":"440000","city":"440300","area":"440305","organ_name":"\u77fd\u4f1f\u667abeta\u7814\u7a76\u9662","organ_kind":"4","creation_date":"2017-09-02 17:10:23"}]}}

1.2 获取学生/老师列表

接口地址

/v1/regional/personList/{type}

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数
参数 必选 类型 说明
RequestBody
type int 类型:1.学生 2.老师
access_token String 用户授权签名
organId int 机构
grade int 年级
class int 班级
organKind int 机构类型
collegeId int 学院id
disciplineId int 学科id
q int 搜索关键字
order string 排序
page int 页数
pageSize int 页码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/regional/personList/1?access_token=xxx
Response
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"5","total_record":"1","record":[{"userId":"917","username":"bbt","organId":"1","organKind":"1","collegeId":null,"disciplineId":null,"classId":"44","typeId":"18","year":"2016","nickName":"4567","sex":"0","organName":"\u77fd\u4f1f\u667a\u5b9e\u9a8c\u5c0f\u5b66","orgClassName":"\u4e8c\u5e74\u7ea7","grade":2,"orgType":"2016\u5e74","organKindName":"\u5c0f\u5b66","orgClass":"3\u73ed","percent":{"study":{"precent":0,"spend_time":0},"answer":{"precent":0,"total":0,"correct":0,"wrong":0},"point":{"precent":0,"total":0,"grasp":0,"disgrasp":0}}}]}}

Response
{"status":200,"data":{"total_page":34,"page":"1","pagesize":"2","total_record":"68","record":[{"userId":"711","username":"zygbb","userType":"2","organId":"1","organKind":"1","collegeId":null,"disciplineId":null,"classId":"35","typeId":"17","year":null,"subject":null,"nickName":"666","sex":"0","organName":"\u77fd\u4f1f\u667a\u5b9e\u9a8c\u5c0f\u5b66","grades":{"17":{"grade":"\u4e00\u5e74\u7ea7","class":["1\u73ed","2\u73ed","3\u73ed"]}},"subjects":[]},{"userId":"693","username":"gulaoshi","userType":"2","organId":"1","organKind":"1","collegeId":null,"disciplineId":null,"classId":"35","typeId":"17","year":null,"subject":"112,107","nickName":"\u53e4\u8001\u5e08","sex":"0","organName":"\u77fd\u4f1f\u667a\u5b9e\u9a8c\u5c0f\u5b66","grades":{"17":{"grade":"\u4e00\u5e74\u7ea7","class":["1\u73ed"]}},"subjects":["\u6570\u5b66","\u4f53\u80b2\u4e0e\u6d3b\u52a8"]}]}}

1.3 获取管理员列表

接口地址

/v1/regional/managerList

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数
参数 必选 类型 说明
RequestBody
access_token String 用户授权签名
organId int 机构
organKind string 类型
q int 搜索关键字
order string 排序
page int 页数
pageSize int 页码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/regional/managerList?access_token=xxx
Response
{"status":200,"data":{"total_page":14,"page":"1","pagesize":"2","total_record":28,"record":[{"userId":"782","username":"beta","mobile":"","userType":"31","creationDate":"2017-09-02 17:11:27","accountStatus":"1","lastLogin":"2017-10-27 09:49:06","isDelete":"N","from":null,"expireDate":null,"nodeName":"\u77fd\u4f1f\u667abeta\u7814\u7a76\u9662","sex":"0","nickName":"\u77fd\u4f1f\u667abeta\u7814\u7a76\u9662\u7ba1\u7406\u5458-\u5458","kind":"4","provinceName":"\u5e7f\u4e1c\u7701","cityName":"\u6df1\u5733\u5e02","areaName":"\u5357\u5c71\u533a","organKind":"\u5927\u5b66"},{"userId":"701","username":"fuyunming","mobile":"","userType":"31","creationDate":"2017-08-14 16:26:15","accountStatus":"-1","lastLogin":"2017-10-13 14:06:20","isDelete":"N","from":null,"expireDate":null,"nodeName":"\u798f\u4e91\u660e\u4e2d\u5b66","sex":"0","nickName":"\u798f\u4e91\u660e\u4e2d\u5b66\u7ba1\u7406\u5458","kind":"2","provinceName":"\u5e7f\u4e1c\u7701","cityName":"\u6df1\u5733\u5e02","areaName":"\u5357\u5c71\u533a","organKind":"\u521d\u4e2d"}]}}

1.4 获取主机列表

接口地址

/v1/regional/nodeList

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数
参数 必选 类型 说明
RequestBody
access_token String 用户授权签名
organId int 机构
q int 搜索关键字
order string 排序
page int 页数
pageSize int 页码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/regional/nodeList?access_token=xxx
Response
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":"1","record":[{"nodeId":"37","nodeSn":"SP05AV100034215A","nodeName":"\u77fd\u4f1f\u667a\u5b9e\u9a8c\u5c0f\u5b66","nodeIp":"192.168.199.185","nodeHost":"http:\/\/sp05av100034215a.nrptest.sewise.com.cn","province":"440000","city":"440300","area":"440305","organKind":"1","typeId":"18","classId":"44","typeKind":"1","organId":"1","version":"3.5.0 build 20170804","versionType":"Beta","modifiedDate":"2017-08-11 09:30:10","organName":"\u77fd\u4f1f\u667a\u5b9e\u9a8c\u5c0f\u5b66","provinceName":"\u5e7f\u4e1c\u7701","cityName":"\u6df1\u5733\u5e02","areaName":"\u5357\u5c71\u533a","online":0,"orgClassName":"\u4e8c\u5e74\u7ea7","organKindName":"\u5c0f\u5b66","orgType":"\u4e8c\u5e74\u7ea7","orgClass":"3\u73ed"}]}}

1.5 编辑使用状态

接口地址

/v1/regional/editStatus

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数
参数 必选 类型 说明
RequestBody
access_token String 用户授权签名
uId int 用userId
status int 状态值: 停用-1,启用1
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/regional/editStatus?access_token=xxx
Response
{"status":200,"data":{xxx}}

1.6 重置密码

接口地址

/v1/regional/changePwd

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数
参数 必选 类型 说明
RequestBody
access_token String 用户授权签名
uId int 用userId
password int 密码值
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/regional/changePwd?access_token=xxx
Response
{"status":200,"data":{xxx}}

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注