获取组织机构数据概况

接口描述:

根据组织机构Id获取组织机构数据概况

接口地址:

请求方式:

  • GET

请求头:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
X-App-Id 客户端 clientId header true string

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
accessToken 接口访问凭证 query true string
orgId 组织机构ID query true integer(int64)

响应状态

状态码 说明 schema
200 OK ApiRestResponse«OrgTreeNodeSummaryVO»

其他状态码参见:全局状态码

响应示例:

正确时返回:

{
    "code": 200,
    "status": "success",
    "message": "请求成功",
    "data": {
        "orgId": 1,
        "teacher": 11383,
        "student": 247,
        "hasChildren": true
    }
}

错误时返回:

{
    "code": 500,
    "data": {},
    "message": "成功或异常消息",
    "status": "fail"
}

响应参数:

参数名称 参数说明 类型 schema
code 成功或异常编码 integer(int32) integer(int32)
data 成功或异常数据 array AppVO
message 成功或异常消息 string
status 旧接口成功、失败或异常辅助判断标记:success、fail、error,可用值:success,fail,error string
Schema 属性:

OrgTreeNodeSummaryVO

参数名称 参数说明 类型 schema
orgId 组织机构id integer(int32)
teacher 组织机构下教师数量 integer(int32)
student 组织机构下学生数量 integer(int32)
hasChildren 是否是有子节点 boolean

调用示例:

NodeJs - Axios:

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api_server_url/org/summary?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/summary?accessToken=AT-3-ewOumlQeTN7TmVufJxq-Ph1fNVnqUTeW")
  .method("GET", null)
  .addHeader("X-App-Id", "1")
  .build();
Response response = client.newCall(request).execute();
作者:杭州天音  创建时间:2022-10-08 17:59
最后编辑:杭州天音  更新时间:2025-08-22 15:44