开发文档-天喻教育云开放平台

组织机构接口

主要使用场景：组织机构接口7.0

1、查询机构、学校列表清单

基础需要授权

根据各种条件查询机构、学校等组织

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://gateway.tianyuyun.com/user/openapi/org/query-org?accessToken={{accessToken}}
请求方式	post
是否需要鉴权	是
请求数限制	否
接口方向	第三方应用->开放平台

参数说明

序号	字段名	约束	类型	说明
1	org_id	可选	String	机构、学校等组织id
2	org_name	可选	String	机构、学校等组织名称
3	org_type	可选	String	组织类型，多个使用英文逗号分隔(1机构，2学校，8企业，9教学工作室，10平台)
4	province_code	可选	String	所属地理省份
5	city_code	可选	String	所属地理市
6	area_code	可选	String	所属地理区
7	status	可选	String	状态,多个使用英文逗号分隔(0:组织未激活,1:正常,2注销)默认不限
8	platform_code	可选	String	实体平台编码
9	v_platform_code	可选	String	虚拟平台编码
10	certification	可选	String	认证(0:未认证,1:已认证)
11	org_category	可选	String	组织的类别(每个类型的组织都有自己的小类别)
12	org_level_code	可选	String	行政区划(行政上所属的区域)
13	org_parent_id	可选	String	上级机构id(查的是直属下级单位)
14	org_parent_ids	可选	String	附属上级机构id(查的是所有的下级单位，包括跨行政级别的下级单位组织)
15	flag	可选	String	标记,多个使用英文逗号分隔,默认正常和演示(0:正常,1:演示,2:测试)
16	org_record_status	可选	String	教育局备案状态,0:未备案，1：已备案
17	page	可选	Int	查询页
18	page_size	可选	Int	查询条数，默认10，上限100
19	sort	可选	string	默认为空，传time : 创建时间倒序

返回说明

序号	字段名	约束	类型	说明
1	code	必选	string	结果编码,000000：成功, 100001：失败
2	message	必选	string	结果描述
3	result	必选	json[]	json数组
3.1	page	必选	int	当前页
3.2	page_size	必选	int	查询量
3.3	count	必选	int	总数
3.4	lists	必选	array	数组对象
3.4.1	org_id	必选	string	组织id
3.4.2	org_name	必选	string	组织名称
3.4.3	org_type	必选	string	组织类型

示例

请求示例
https://gateway.tianyuyun.com/user/openapi/org/query-org?accessToken=ACCESS_TOKEN
{
   "org_name" : "小学",
   "org_type":"2",
   "org_category":"0"
}
返回示例
{
  "code": "000000",
  "message": "成功",
  "result": {
    "page": 1,
    "page_size": 10,
    "count": 2,
    "lists": [
      {
        "org_id": "dde57a52919d11e9b8620200f766f6f0",
        "org_name": "武汉市电教中心",
        "org_type": 1
      },
      {
        "org_id": "34e6b70e8c4311e9bc3b0200f70dd853",
        "org_name": "武汉市教育局",
        "org_type": 1
      }
    ]
  }
}

开发者登录

1、查询机构、学校列表清单

前置条件

请求说明

参数说明

返回说明

示例