top
关闭

开发者登录

组织机构接口

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

1、获取机构、学校详情7.0

基础 需要授权

该接口能获取机构,学校,企业,工作室等具有独立性质的组织详情

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

序号 字段名 约束 类型 长度 说明

1

org_id

必选

string

机构、学校等组织id

返回说明

序号 字段名 约束 类型 长度 说明

1

code

必选

string

结果编码,000000:成功, 100001:失败

2

message

必选

string

结果描述

3

result

必选

string

结果数据

3.1

org_id

必选

string

组织id

3.1

province_code

必选

string

地理省份

3.2

platform_code

必选

string

实体平台编码

3.3

v_platform_code

必选

string

虚拟平台编码

3.4

org_name

必选

string

组织名称

3.5

org_short_name

必选

string

组织简称

3.6

org_type

必选

string

组织类型("1": "机构","2": "学校","3": "校区","4": "部门","5": "学段","6": "年级","7": "班级","8": "企业机构","9": "教学工作室","10": "平台")

3.7

create_user_id

必选

string

创建者id

3.8

createtime

必选

string

创建时间

3.9

updatetime

必选

string

更新时间

3.11

city_code

必选

string

地理城市

3.12

area_code

必选

string

地理区域

3.13

status

必选

string

状态,0:组织未激活,1:正常,2:解散,3:锁定

3.14

certification

必选

string

认证(0:未认证,1:已认证)

3.15

org_level

可选

string

行政等级,是机构、学校类型时返回 “1”: “国家” “2”: “省级” “3”: “地级” “4”: “县级” “5”: “乡级”

3.16

org_level_code

必选

string

行政区划,是机构、学校类型时返回

3.17

org_parent_id

可选

string

直属上级机构id,是机构、学校类型认证的组织才能有(比如A学校的上级是AA机构,AA机构的上级是AAA机构)

3.18

org_address

可选

string

组织的联系地址

3.19

org_category

可选

int

组织的类别(org_type为0时,机构:0: "行政类",1: "电教类", 2: "装备类","3": "党政类","99": "教育局" org_type为1时,学校:0: "小学",1: "初中",2: "高中",3: "完中" ,5: "教学点",6: "九年一贯制",7: "十二年一贯制", 8: "高等教育",9: "其它教育类学校",10: "中职",11:"高职",12: "学前教育"),未设置时为空字符串

3.20

org_category_title

可选

string

组织的类别名称(org_type为0时,机构:0: "行政类",1: "电教类", 2: "装备类","3": "党政类","99": "教育局" org_type为1时,学校:0: "小学",1: "初中",2: "高中",3: "完中" ,5: "教学点",6: "九年一贯制",7: "十二年一贯制", 8: "高等教育",9: "其它教育类学校",10: "中职",11:"高职",12: "学前教育")

3.21

avatar

必选

string

头像地址

3.22

school_is_smart_campus

可选

string

学校属性 - 是否智慧校园(1是 0 否)

3.23

org_coding

必选

string

机构、学校属性 - 短编码

3.24

org_has_child

可选

string

机构属性 - 机构是否存在下级组织(1是,0否)

示例

请求示例
https://gateway.tianyuyun.com/user/openapi/org/get-org-info?org_id=123&accessToken={{accessToken}}
返回示例
{
  "code": "000000",
  "message": "请求成功",
  "result": {
    "org_id": "c2d2a224-5a9a-11e9-9c82-0200f7b88099",
    "union_org_id": "c2d2a224-5a9a-11e9-9c82-0200f7b88099",
    "platform_code": "999999",
    "v_platform_code": "999999",
    "org_name": "武汉市第一初级中学",
    "org_short_name": "武汉市第一中学",
    "org_type": "2",
    "create_user_id": "af144ae4-5a9a-11e9-9c82-0200f7b88099",
    "createtime": "1554795635",
    "updatetime": "1555126603",
    "province_code": "420000",
    "city_code": "420100",
    "area_code": "420106",
    "status": "1",
    "certification": "0",
    "flag": "0",
    "level": "0",
    "verify_mode": "0",
    "group_id": "",
    "org_address": "",
    "org_telephone": "",
    "org_email": "",
    "member_custom_field": [
      "兴趣爱好"
    ],
    "member_show_filed": {
      "default": [
        "gender",
        "job",
        "email",
        "text"
      ],
      "custom": [
        "兴趣爱好"
      ],
      "system": [
        "name",
        "depart",
        "user_type",
        "gender",
        "phone",
        "card_code"
      ]
    }
  }
}