当前版本:
version= V1.0
接口功能:
用于分页获取RunLan平台学生基本信息。
接口地址:
/api/v1/student/queryStudents
请求方式:
POST
请求参数:
Body
| 参数名称 | 是否必选 | 说明/示例 | |
|---|---|---|---|
| selType | 是 | Int | 查询类型 0:分页查询,1:列表查询 |
| page | 条件必选(当selType=0时必选,下同) | Int | 页码 |
| pageSize | 条件必选 | Int | 每页大小 |
| idCardNumber | 否 | String | 身份证号 |
| timestamp | 否 | String | 变化数据的开始时间戳(13位,ms),如:1735225753000 |
说明:为了保证系统的效率,建议每次取数据最多不超过300条数据。
返回值说明
| 返回值字段 | 类型 | 说明 |
|---|---|---|
| msg | String | 提示信息 |
| code | String | 200成功,其他为失败 |
| data | List | 学生基本信息(分页)结果集 |
result结果集返回值字段说明
数据均以updateTime正序返回
| 返回值字段 | 类型 | 说明 |
|---|---|---|
| total | Int | 总条数 |
| current | Int | 当前页 |
| size | Int | 每页条数 |
| rows | Array | 当前分页学生基础信息数据集 |
| data | Object | 学生基础信息(当数据为空时为data:[]) |
| studentID | String | 学生ID(非空) |
| studentName | String | 姓名 |
| studentSex | String | 性别(1男/0女) |
| documentType | String | 证件类型(中文) |
| idCardNumber | String | 证件号码,如身份证号码、护照号等 |
| politicalStatusName | String | 政治面貌名称 |
| politicalStatusID | String | 政治面貌ID |
| nationName | String | 民族(中文) |
| nationID | String | 民族ID |
| specialtyName | String | 专业名称 |
| specialtyID | String | 专业ID |
| classID | String | 班级ID |
| className | String | 班级名称 |
| eduLength | Int | 学制 |
| isLiveInSchool | Int | 是否住校,0不住 1住 |
| studentStateID | String | 在读状态ID |
| studentStateName | String | 在读状态名称 |
| isDelete | Int | 删除状态,1删除0正常 |
| studentNumber | String | 学号 |
| phoneNumber | String | 手机号码 |
| registerTime | String | 注册时间 yyyy-MM-dd HH:mm:ss |
| updateTime | String | 信息更新时间,格式:yyyy-MM-dd HH:mm:ss |
返回结果示例(JSON)
返回成功
列表查询
{
"success": true,
"code": 200,
"msg": "成功",
"data": [
{
"studentID": "BC6EC4F8-465C-EF9C-361B-BA5D56B6F113",
"studentName": "刘佳乐",
"studentSex": "1",
"idCardNumber": "341282200812251456",
"documentType": null,
"studentNumber": "G341282200812251456",
"departmentName": "汽车与机电技术系",
"departmentID": "4870f51d-6c78-43a0-8db4-a6182d899ee6",
"specialtyName": "数控加工(水湖校区)",
"specialtyID": "e9118f1d-2ba6-426b-a5ee-d6ae7e13c6be",
"nationName": "汉族",
"nationID": "00d9eca2-f8ba-3826-84ac-7d6b4418c9e1",
"className": null,
"classID": null,
"termID": "1f61465a-d4f8-4541-93f6-e4fd98687198",
"termName": "2024~2025【第一学期】",
"politicalStatusID": null,
"politicalStatusName": null,
"isLiveInSchool": 1,
"isDelete": 1,
"registerTime": "2024-08-17 14:18:29",
"phoneNumber": "13035077305",
"studentStateID": null,
"studentStateName": null,
"updateTime": "2025-03-12 17:44:42"
},
{
"studentID": "bcb1e119-dde8-4790-99ac-29ff672fa90b",
"studentName": "闫昊宇",
"studentSex": "1",
"idCardNumber": "340121200705010017",
"documentType": "居民身份证",
"studentNumber": "23230694",
"departmentName": "建筑艺术系",
"departmentID": "9353ef2f-97bf-4c9c-a45b-da9cf17869e7",
"specialtyName": "建筑装饰(望湖校区)",
"specialtyID": "30c6e318-5480-47ee-9e1f-6b475cee0766",
"nationName": "汉族",
"nationID": "00d9eca2-f8ba-3826-84ac-7d6b4418c9e1",
"className": "2023级建筑装饰五年高级1班",
"classID": "112ee7a5-f9cb-4ae1-94bd-4bf77603a47d",
"termID": "734cbf6d-020e-4c22-b866-de703fb5e6c1",
"termName": "2023~2024【第一学期】",
"politicalStatusID": null,
"politicalStatusName": null,
"isLiveInSchool": 1,
"isDelete": 0,
"registerTime": null,
"phoneNumber": null,
"studentStateID": "3C0A1190-958B-EE4E-FB9B-AB5BA52C1DCA",
"studentStateName": "在读",
"updateTime": "2025-03-12 17:44:42"
}
]
}
分页查询
{
"success": true,
"code": 200,
"msg": "成功",
"data": {
"total": 14873,
"current": 1,
"size": 2,
"rows": [
{
"studentID": "0049781b-2768-46dc-8f9f-7f796d4fc404",
"studentName": "夏子寒",
"studentSex": "1",
"idCardNumber": "341282200611220178",
"documentType": "居民身份证",
"studentNumber": "21230724",
"departmentName": "建筑工程系",
"departmentID": "c7da93b8-b676-4f9c-b386-a7680e58efa2",
"specialtyName": "建筑施工",
"specialtyID": "a5a57d63-3ed6-42ee-b1e1-45d57fffef64",
"nationName": "汉族",
"nationID": "00d9eca2-f8ba-3826-84ac-7d6b4418c9e1",
"className": "2021级建筑施工五年高级2班",
"classID": "72412fad-d8d6-4ced-8067-5ef1e5931dd2",
"termID": "c880a3cc-a21b-4054-a97d-3642c7361754",
"termName": "2021~2022【第一学期】",
"politicalStatusID": null,
"politicalStatusName": null,
"isLiveInSchool": 1,
"isDelete": 0,
"registerTime": null,
"phoneNumber": null,
"studentStateID": "3C0A1190-958B-EE4E-FB9B-AB5BA52C1DCA",
"studentStateName": "在读",
"updateTime": "2025-03-12 17:44:42"
},
{
"studentID": "0076de06-7242-442e-bd72-8777edf199af",
"studentName": "黄瑞",
"studentSex": "1",
"idCardNumber": "341022200412261519",
"documentType": "居民身份证",
"studentNumber": "21230439",
"departmentName": "信息技术系",
"departmentID": "dcee37f9-8ceb-4fae-a8ae-65c365ddfbcb",
"specialtyName": "计算机程序设计(望湖校区)",
"specialtyID": "2749d6f9-f224-449f-92d0-5be1c2760c93",
"nationName": "汉族",
"nationID": "00d9eca2-f8ba-3826-84ac-7d6b4418c9e1",
"className": "2021级计算机程序设计五年高级班",
"classID": "4ca38d87-f20b-42c5-afe2-fb3ff76fd487",
"termID": "c880a3cc-a21b-4054-a97d-3642c7361754",
"termName": "2021~2022【第一学期】",
"politicalStatusID": null,
"politicalStatusName": null,
"isLiveInSchool": 1,
"isDelete": 0,
"registerTime": null,
"phoneNumber": null,
"studentStateID": "3C0A1190-958B-EE4E-FB9B-AB5BA52C1DCA",
"studentStateName": "在读",
"updateTime": "2025-03-12 17:44:42"
}
]
}
}
返回失败
{
"msg":"获取数据失败!",
"status":-999
}
版本变更说明:
无