一、基本信息
接口名称:获取学校学生列表接口
接口说明:获取学校所有学生数据,可使用参考学生详细信息接口(学生班级对应关系接口 + 学生信息接口)
请求地址:${BASEURL}/dataconnectorserv/integration/basic/getStudents
请求方式:POST
请求类型:application/json
接口频率:接口调用上限500次/天
接口版本:3.0
修改日期:2023-12-05
二、请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| appKey | String | 是 | 平台提供的唯一标识 |
| schoolID | String | 是 | 学校ID,从学校列表获取 |
{
"appKey": "36s2zllw",
"schoolID": "wca5opSRt2tyyBSLqOjdoS=="
}
三、响应结果
| 响应参数名称 | 响应参数类型 | 是否有值 | 说明 |
|---|---|---|---|
| students | Array | 是 | 学生列表 |
| loginName | String | 是 | 登录名(学校学号/学籍号/身份证号)唯一 |
| studentEID | String | 是 | 学生EID,EID可切换1.平台ID,2.登录名,3.第三方厂商ID |
| studentName | String | 是 | 学生姓名 |
| gender | String | 是 | "男"或"女",null值,表示未知 |
| pic | String | 是 | BASE64编码JPEG图片,缺字段或null值表示未提供照片(暂无) |
| extraField1 | String | 否 | 备注1(学籍主号) 备注字段,默认为空 |
| extraField2 | String | 否 | 备注2(学籍辅号) 备注字段,默认为空 |
| extraField3 | String | 否 | 备注3(校内学号) 备注字段,默认为空 |
| updateTime | String | 是 | 更新时间(格式化UTC时间,比北京时间早8小时,UTC+时区差=本地时间) |
{
"code": 0,
"status": "success",
"result": {
"students": [
{
"loginName": "5132022039",
"studentEID": "5132022039",
"studentName": "吕诸林",
"gender": "男",
"pic": null,
"extraField1": "",
"extraField2": "",
"extraField3": "",
"updateTime": "2023-10-15T16:02:15Z"
},
{
"loginName": "5132022058",
"studentEID": "5132022058",
"studentName": "李妤佳",
"gender": "女",
"pic": null,
"extraField1": "",
"extraField2": "",
"extraField3": "",
"updateTime": "2023-10-15T16:02:15Z"
}
]
}
}