文档
测试

获取学生数据

GET
http://{ip}:19081/localdoor/localSchool/user/api/pageStudentInfo?rows=1&start=1&schoolIds=115&userName=123abc&passWord=123abc&serviceNumber=localInfo

接口描述

分页获取学生数据> > > 主动获取模块仅适用于局域网内网

基本信息

|-|说明| |----|-------------------------| |接口状态|开发完成| |请求类型|GET| |接口URL|http://{ip}:19081/localdoor/localSchool/user/api/pageStudentInfo?rows=1&start=1&schoolIds=115&userName=123abc&passWord=123abc&serviceNumber=localInfo |Content-Type |multipart/form-data| |接口说明|分页查询单页限制1000条,入参超过1000自动转换为1000条。 只查询正常或休学状态的学生,studentStatus等于1或等于2。 |

请求参数

参数名
类型
示例
描述
必填
rows
int
10
每页行数,默认10行最大1000
可选
start
int
1
开始页数,默认1
可选
schoolIds
array
115
获取数据学校id多个逗号隔开, 仅在当前学校分组里面的,并且是配置了才能获取
必填
userName
string
123abc
用户名(具体值, 询问相关对接人员)
必填
passWord
string
123abc
密码(具体值, 询问相关对接人员)
必填
serviceNumber
string
localInfo
服务商编号(具体值, 询问相关对接人员)
必填

响应参数

参数名
类型
示例
描述
必填
code
int
200
响应码200为空成功
必填
message
string
操作成功
说明
必填
data
object
数据
必填
totalSize
int
9452
总条数
必填
size
int
10
本次数据条数
必填
result
array
数据列表
必填
schoolId
string
115
学校唯一Id
可选
schoolName
string
外国语实验学校1
学校名称
可选
studentId
string
1767458920226553856
学生id(学生id加学校id唯一)
可选
studentName
string
夏洛
学生名称
可选
studentStatus
string
1
学生状态【1:正常;2:休学;3:归档;4:待录取;5:已拒绝;6:草稿;7:待分班】
可选
gradeName
string
2024届
学界名称
可选
acaStage
string
学前
学段名称
可选
className
string
小二班
班级名称
可选
readType
object
1
读书形式【1:走读;0:住读】(可能为空null或""表为未设置)
可选
certNum
string
510000201901011234
证件号
可选
cardNum
object
7890876321
卡号(十进制)
可选

响应示例

> 以下示例‘result’包含所有字段, 可以灵活配置返回那些字段, 调用时有些字段未返回属于正常情况, 具体要那些字段可以联系相关对接人员。 ```json { "code": 200, "message": "操作成功", "data": { "totalSize": 9452, //总条数 "size": 1, //本次数据条数 "result": [{ "schoolId": "115", //所在学校 "schoolName": "外国语实验学校1", //学校名称 "studentId": "1767458920226553856", //学生id "studentName": "夏洛", //学生名称 "studentStatus": "1", //学生状态 "gradeName": "2024届", //学界名称 "acaStage": "学前", //所在学段 "className": "小二班", //所在班级 "readType": 1, //住读方式 "certNum": "510000201901011234", //证件号 "cardNum": "7890876321"//学生卡号(十进制) }] //返回数据 } } ```

错误响应示例

```json { "code": 10031, "message": "用户名或密码不正确" } ```

错误码说明

>1001-开头的错误码, 是配置问题, 请直接联系我们解决。 >1002-开头错误码, 是无权限或未按配置约束调用接口, 请先自行检查后联系我们。 >1003-开头错误码, 请检查传入参数, 不能自行解决请联系我们, 有可能给的调用地址或配置变更。 |错误码|描述|解决方案| |---|---|---| |10012|服务商配置错误 |联系相关对接人员检查配置| |10013|配置错误时间格式错误 |联系相关对接人员检查配置| |10014|配置错误可获取的学校错误 |联系相关对接人员检查配置| |508|请求参数不足 |检查必传参数是否为空| |10021|无查询权限不在白名单内 |ip不在白名单中, 请在正确环境调用或联系我们添加白名单| |10022|服务商配置不存在 |请先检查服务商编号是否正确(serviceNumber),不能解决请联系相关对接人员检查配置| |10023|获取信息功能已经关闭 |请先确定, 要查询老师还是学生数据权限, 或2个权限都需要, 然后联系相关对接人员添加权限| |10024|当前时间禁止访问 |请在我方约束时间内访问接口| |10025|未配置学校查询权限 |请检查传入学校id是否正确(schoolIds), 如果需要查询更多学校联系我们| |10031|用户名或密码不正确 |检查传入的用户和密码, 不能有回车和空格| |10032|传入学校id必须在当前学校分组里面 |请检查传入学校id是否正确(schoolIds), 学校id必须在当前学校分组里面|