学生基本信息情况查询接口

接口描述：

  • 学生基本信息情况查询

接口地址:

请求方式：

  • GET

请求头：

参数名称 参数说明 请求类型 是否必须 数据类型
X-App-Id 客户端 clientId header true string

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
page 页码（默认为1） Integer false Integer
limit 每页大小（默认为10 最大为100） Integer false Integer
xn 学年(默认为当前学年 格式为2024-2025) VARCHAR false VARCHAR

请求示例

https://api_server_url/openApi/v1/student/list?accessToken={token}&page=1&limit=10&xn=2024-2025

响应状态

状态码 说明
200 OK

其他状态码参见：全局状态码

响应示例:

正确时返回:

{
    "code": 200,
    "status": "success",
    "message": "请求成功",
    "data": {
        "records": [
            {
                "xh": "123",
                "studentName": "123",
                "gradeCode": "11",
                "gradeName": "一年级",
                "className": "测试班"
            }
        ],
        "total": 2056,
        "size": 10,
        "current": 1,
        "pages": 2056
    }
}
字段 说明 类型
records 数据集合 ARRAY
records[0].xh 学生学号 VARCHAR
records[0].studentName 学生姓名 VARCHAR
records[0].gradeCode 年级代码 VARCHAR
records[0].gradeName 年级名称 VARCHAR
records[0].className 班级名称 VARCHAR
total 数据总量 Number
size 每页大小 Number
current 当前页码 Number
pages 总共页数 Number

错误时返回:

{
    "code": 500,
    "data": {},
    "message": "成功或异常消息",
    "status": "fail"
}

响应参数:

参数名称 参数说明 类型 schema
code 成功或异常编码 integer(int32) integer(int32)
data 成功或异常数据 array
message 成功或异常消息 string
status 旧接口成功、失败或异常辅助判断标记:success、fail、error,可用值:success,fail,error string