基础数据接口
主要使用场景:开发者可以通过该接口获取相关基础数据
1、获取区域编码信息
第三方应用可以通过该接口获取体系中的区域信息。
请求说明
url |
/baseInfo/getAreaList |
协议 |
post |
参数说明
序列号 |
字段名 |
约束 |
类型 |
说明 |
1 |
parentCode |
可选 |
String |
上级区域编码(0代表顶级区域) |
2 |
pageNo |
可选 |
Int |
获取记录的页数,默认1 |
3 |
pageSize |
可选 |
Int |
获取每页的条数,默认10,最大值500 |
返回说明
序列号 |
字段名 |
约束 |
类型 |
说明 |
1 |
retCode |
必选 |
String |
返回码
000000:成功 |
2 |
retDesc |
必选 |
String |
返回码描述 |
3 |
data |
必选 |
JSON |
返回的结果集 |
3.1 |
count |
必选 |
Int |
分页总条数 |
3.2 |
dataList |
必选 |
JSON[] |
返回的列表信息 |
3.2.1 |
areaCode |
可选 |
String |
区域编码 |
3.2.2 |
areaName |
可选 |
String |
区域名称 |
3.2.3 |
areaType |
可选 |
String |
区域类型(1:省级区域;2:地市级区域:3:区县级区域) |
3.2.4 |
parentCode |
可选 |
String |
上级区域编码 |
3.2.5 |
sortNo |
可选 |
Int |
排序号 |
示例
请求报文
{
"parentCode":"0",
"pageNo": 1,
"pageSize": 10
}
应答报文
{
"retCode": "000000",
"retDesc":"成功",
"data":{
"count":33,
"dataList": [{
"areaCode":"110100",
"areaName":"北京市",
"areaType":"1",
"parentCode":"0",
"sortNo":"3"
}]
}
}
2、获取机构编码信息
获取机构编码信息
请求说明
url |
/baseInfo/getOrgList |
协议 |
post |
参数说明
序列号 |
字段名 |
约束 |
类型 |
说明 |
1 |
provinceCode |
可选 |
String |
省级编码 |
2 |
cityCode |
可选 |
String |
地市级编码 |
3 |
areaCode |
可选 |
String |
区县级编码 |
4 |
orgId |
可选 |
String |
机构ID |
5 |
orgName |
可选 |
String |
机构或者学校名称,支持模糊查询 |
6 |
orgType |
可选 |
String |
机构类型:4-机构,其他是学校 |
7 |
pageNo |
可选 |
Int |
获取记录的页数,默认1 |
8 |
pageSize |
可选 |
Int |
获取每页的条数,默认10,最大条数不超过500 |
9 |
eduType |
可选 |
String |
教育类型(edu_type_0-基教;edu_type_1-职教),不填默认返回所有类型 |
返回说明
序列号 |
字段名 |
约束 |
类型 |
说明 |
1 |
retCode |
必选 |
String |
返回码
000000:成功
200001: 必选参数为空
300006: 用户会话票据失效 |
2 |
retDesc |
必选 |
String |
返回码描述 |
3 |
data |
必选 |
JSON |
返回的结果集 |
3.1 |
count |
必选 |
Int |
分页总条数 |
3.2 |
dataList |
必选 |
JSON[] |
返回的机构列表信息 |
3.2.1 |
orgId |
可选 |
String |
机构Id |
3.2.2 |
orgName |
可选 |
String |
机构名称 |
3.2.4 |
orgType |
可选 |
String |
机构类型 0:小学, 1:初中, 2:高中, 3:完中, 4:机构, 5:教学点, 6:九年一贯制, 7:十二年一贯制, 8:高等教育, 9:其他教育类, 10:中职,11:高职, 12:幼儿园 |
3.2.5 |
provinceCode |
可选 |
String |
省级编码 |
3.2.6 |
cityCode |
可选 |
String |
地市级编码 |
3.2.7 |
areaCode |
可选 |
String |
区县级编码 |
示例
请求报文:
{
"provinceCode":"420000",
"cityCode": "420100",
"areaCode":"420101",
"orgName":"某某中学",
"orgType":"3",
"pageNo":"1",
"pageSize":"10"
}
应答报文:
{
"retCode":"000000",
"retDesc": "成功",
"data":{
"count":150,
"dataList":[{
"orgId":"257fa1e******a4b3285ee",
"orgName":"某某中学",
"orgType": "2",
"provinceCode":"420000",
"cityCode":"420100",
"areaCode":"420101"
}]
}
}