一、基本信息
接口名称:获取学校列表信息
接口说明:通过授权厂商appKey授权开通相应的学校列表,将学校列表的SchoolID作为参数,请求基础数据和业务接口数据
请求地址:${BASEURL}/dataconnectorserv/integration/basic/getSchools
请求方式:POST
请求类型:application/json
接口频率:接口调用上限500次/天
接口版本:3.0
修改修改日期:2023-12-05
小提示
1、获取学校列表需授权appKey开通对接学校,才能获取学校列表数据。
2、获取学校列表数据后,将学校列表中SchoolID作为参数使用,请求基础数据和业务数据接口。
二、请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| appKey | String | 是 | 平台提供的唯一标识 |
{
"appKey": "36s2zllw"
}
三、响应结果
| 响应参数名称 | 响应参数类型 | 是否有值 | 说明 |
|---|---|---|---|
| schools | Array | 是 | 学校列表 |
| schoolID | String | 是 | 学校唯一标识ID |
| schoolName | String | 是 | 学校名称 |
| regionID | String | 是 | 学校所属区域ID |
| provinceName | String | 否 | 学校所属省份,为空,不显示该字段 |
| cityName | String | 否 | 学校所属市,为空,不显示该字段 |
| districtName | String | 否 | 学校所属区/县,为空,不显示该字段 |
{
"code": 0,
"status": "success",
"result": {
"schools": [
{
"schoolID": "wca5opSRt2tyyBSLqOjdoS==",
"schoolName": "北京市演示学校",
"regionID": "110115",
"provinceName": "北京市",
"cityName": "大兴区"
},
{
"schoolID": "mV26+aYsFvYjseYuoWe24w==",
"schoolName": "厦门市演示学校",
"regionID": "350203",
"provinceName": "福建省",
"cityName": "厦门市",
"districtName": "思明区"
}
]
}
}