[DEMO] 全国中学基础信息

全国中学基础信息
接口详情官网地址: https://www.gugudata.com/api/details/middleschool

提供全国初级高级中学基础数据

请求方法: GET
接口路径: /metadata/middle-school
调试地址: https://api.gugudata.com/metadata/middle-school/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

请求参数:

appkey (string, 必填): 付费后获取的 APPKEY

pageIndex (int, 必填): 页码，第几页数据

pageSize (int, 必填): 每页数据量，参数最大值为 20

schoolType (string, 可选): 中学类型：ALL (不限制) | MIDDLE_SCHOOL (初级中学) | HIGH_SCHOOL (高级中学)

schoolName (string, 可选): 学校名称，模糊搜索，参数默认值为空，不进行筛选

provinceName (string, 可选): 学校所在省份，参数默认值为空，不进行筛选

cityName (string, 可选): 学校所在城市，参数默认值为空，不进行筛选

返回字段:

RequestParameter: 接口请求参数

DataStatus.StatusCode: 接口返回状态码

DataStatus.StatusDescription: 接口返回状态说明

DataStatus.ResponseDateTime: 接口数据返回时间

DataStatus.DataTotalCount: 此条件下的总数据量，一般用于分页计算

Data.Id: 数据全局唯一 ID，仅用于标识数据的唯一

Data.SchoolName: 中学学校名称

Data.SchoolType: 中学类型

Data.Province: 学校所在省份

Data.City: 学校所在城市

Data.District: 学校所在区县

Data.Address: 学校地址

Data.PostalCode: 学校邮政编码

Data.PhoneCode: 学校电话区号

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

100 正常返回: 暂无说明

101 参数错误: 暂无说明

102 请求频率受限: 每秒请求不能超过 100 次

103 账号欠费: 暂无说明

104 APPKEY 错误: 请检查传递的 APPKEY 是否为开发者中心获取到的值

110 接口响应错误: 暂无说明

接口特性:

提供最新全国中学学校基本信息；

包含全国初级中学与高等中学；

总计近 10 万条全国中学精准数据；

每月一次数据自动更新校正；

包含学校各类属性信息；

毫秒级响应性能；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口极速响应，多台服务器构建 API 接口负载均衡；

返回响应

🟢200成功

application/json

Body

示例

{
  "RequestParameter": "string",
  "DataStatus": {
    "StatusCode": 0,
    "StatusDescription": "string",
    "ResponseDateTime": "string",
    "DataTotalCount": 0
  },
  "Data": {
    "Id": "string",
    "SchoolName": "string",
    "SchoolType": "string",
    "Province": "string",
    "City": "string",
    "District": "string",
    "Address": "string",
    "PostalCode": "string",
    "PhoneCode": "string"
  }
}

请求参数

请求示例代码

返回响应