获取组织机构列表
接口描述:
获取组织机构列表,该组织机构列表上包含了教育局、事业单位、学校类型的机构数据
接口地址:
请求方式:
- GET
请求头:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
X-App-Id | 客户端 clientId | header | true | string |
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
accessToken | 组织机构ID | query | false | string |
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | ApiRestResponse«List«TreeNode»» |
其他状态码参见:全局状态码
响应示例:
正确时返回:
{
"code": 200,
"status": "success",
"message": "请求成功",
"data": [
{
"id": "1",
"type": "node_jyj",
"code": "1",
"name": "拱墅区教育局",
"parentId": "0",
"leaf": false,
"children": []
}
]
}
错误时返回:
{
"code": 500,
"data": {},
"message": "成功或异常消息",
"status": "fail"
}
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 成功或异常编码 | integer(int32) | integer(int32) |
data | 成功或异常数据 | array | TreeNode |
message | 成功或异常消息 | string | |
status | 旧接口成功、失败或异常辅助判断标记:success、fail、error,可用值:success,fail,error | string |
Schema 属性:
TreeNode
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
id | 组织机构节点id | integer(int64) | |
leaf | 是否是叶子节点 | boolean | |
code | 组织机构编码 | string | |
name | 组织机构名称 | string | |
parentId | 父级节点id | integer(int64) | |
type | 组织机构树节点类型,可用值:node_sjyj,node_jyj,node_dept,node_category,node_sydw,node_school,node_campus,node_grade,node_major,node_class | string |
调用示例:
NodeJs - Axios:
var axios = require('axios');
var config = {
method: 'get',
url: 'https://api_server_url/org/list?accessToken=AT-3-ewOumlQeTN7TmVufJxq-Ph1fNVnqUTeW',
headers: {
'X-App-Id': '1'
}
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Java - OkHttp 示例:
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api_server_url/org/list?accessToken=AT-3-ewOumlQeTN7TmVufJxq-Ph1fNVnqUTeW")
.method("GET", null)
.addHeader("X-App-Id", "1")
.build();
Response response = client.newCall(request).execute();
作者:杭州天音 创建时间:2022-10-24 18:37
最后编辑:杭州天音 更新时间:2025-08-22 15:44
最后编辑:杭州天音 更新时间:2025-08-22 15:44