机构基本信息API

主要使用场景：需要获取机构信息时使用，包括机构基本信息、层级关系和管理员信息

1获取机构管理员列表
2微网站平台首页轮播图片
3获取机构基本信息
4微网站(平台/学校)最新资讯列表
5通过机构栏目id获取学校资讯列表接口
6根据区域编码获取区域信息
7获取下级机构列表

1、获取机构管理员列表

根据机构id获取机构的管理员身份列表信息

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://opengate.huijiaoyun.com/baseInfo/org/getOrgAdminList?accessToken=ACCESS_TOKEN
请求方式	post
格式	json
是否需要鉴权	是
请求数限制	是
接口方向	第三方应用>开放平台

参数说明

序号	字段名	约束	位置	类型	长度	说明
1	orgId	必选	Body(json)	String	64.0	机构Id

返回说明

序号	字段名	约束	类型	长度	说明
1	retCode	必选	String	6.0	返回码
2	retDesc	必选	String	100.0	返回码描述
3	count	必选	String	8.0	总记录条数
4	adminList	可选	Json对象	-	机构管理员用户信息列表
4.1	persionId	可选	String	64.0	用户个人Id
4.2	name	可选	String	100.0	用户姓名
4.3	userType	可选	String	1.0	用户类型: 1:学生老师 2:家长 3:机构 4:学校 5:学校工作人员 6:机构工作人员
4.4	gender	可选	String	1.0	性别: 0:女 1:男

示例

							请求报文：
{
    "orgId": "AF5C6A7A49124B20B8A******",
    "start":"1",
    "end":"2"
}
应答报文：
{
    "retCode": "000000",
    "start": "1",
    "end": "2",
    "count": "10",
    "adminList": [
        {
        "persionId": "AF5C6A7A******",
        "name": "刘******",
        "userType": "2013-10-13 21:09:33",
        "gender": "4"
        }
    ],
    "retDesc": "success"
}

2、微网站平台首页轮播图片

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://opengate.huijiaoyun.com/portal/api/mobilebanner
请求方式	POST
格式	json
是否需要鉴权	是
请求数限制	否
接口方向	第三方应用>开放平台

参数说明

序号	字段名	约束	位置	类型	长度	说明
1	schoolid	必选	Body(json)	string	-	平台编码code
2	title	必选	Body(json)	string	-	banner模块类型名称(值必须为“微网站”，并且后台必须创建此banner模块类型)
3	Token	可选	Body(json)	string	-	作为微网站独有接口的标识，可选填项（默认为'weiwz'）

返回说明

序号	字段名	约束	类型	长度	说明
1	retCode	可选	string	-	返回的编码标识（判断返回正确或错误的标识）
2	result	可选	json	-	返回的是个json数组，是想要的数据信息
2.1	lists	可选	string	-	返回的是个json数组，是想要的数据信息
2.1.1	id	可选	int	-	返回该banner的id
2.1.2	title	可选	string	-	返回该banner的标题
2.1.3	status	可选	string	-	返回该banner图是否显示状态（0隐藏，1显示）
2.1.4	small_ur	可选	string	-	返回banner的小图片地址
2.1.5	url	可选	string	-	返回banner的图片地址
2.1.6	link	可选	string	-	返回banner图的跳转连接
2.1.7	schoolid	可选	string	-	返回平台/学校id

示例

							请求报文：
{
	"sid": "888888",
	"catename": "微网站",
	"token": "weiwz"
}
应答报文：
返回：
{
	"retCode": "000000",
	"result": {
		"lists": [{
			"id": null,
			"title": "\u6d4b\u8bd5",
			"viewcount": null,
			"status": null,
			"small_url": null,
			"url": "school\/album\/2019\/0316\/232\/5c8ca73b61bdc.png",
			"datetime": null,
			"userid": null,
			"username": null,
			"schoolid": null,
			"schoolname": null,
			"listorder": null,
			"link": "http:\/\/www.baidu.com",
			"type": null,
			"module": null,
			"position": null
		}],
		"pages": {
			"pageVar": "page",
			"route": "",
			"params": null,
			"validateCurrentPage": true
		},
		"total": 1
	},
	"message": "\u672a\u77e5\u9519\u8bef",
	"runtime": "1,552,721,783.29505"
}

3、获取机构基本信息

根据id获取机构或学校的基本表信息。

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://opengate.huijiaoyun.com/baseInfo/org/getOrgInfo?accessToken=ACCESS_TOKEN
请求方式	post
格式	json
是否需要鉴权	是
请求数限制	是
接口方向	第三方应用>开放平台

参数说明

序号	字段名	约束	位置	类型	长度	说明
1	orgId	必选	Body(json)	String	64.0	机构id

返回说明

序号	字段名	约束	类型	长度	说明
1	retCode	必选	String	6.0	返回码
2	retDesc	可选	String	100.0	返回码描述
3	orgInfo	可选	Json对象	-	机构信息对象
3.1	createTime	可选	String	32.0	创建时间
3.2	orgCode	可选	String	64.0	机构代码
3.3	orgId	可选	String	64.0	机构Id
3.4	orgPic	可选	String	512.0	机构图片
3.5	orgName	可选	String	300.0	机构名称
3.6	orgCage	可选	String	2.0	机构属性：机构类别 0:小学 1:初中 2:高中 3:完中 4:机构 5:教学点 6:九年一贯制 7: 十二年一贯制
3.7	provinceCode	可选	String	10.0	省编码
3.8	cityCode	可选	String	10.0	市编码
3.9	areaCode	可选	String	10.0	区编码
3.10	orgType	可选	String	2.0	机构类型： 1:国家 2:区域 3:市 4:区

示例

							请求报文：
{
    "orgId": "AF5C6A7A49124B20B8A******"
}
应答报文：
{
   "retCode": "000000",
   "retDesc": "success",
   "orgInfo":    {
      "areaCode": "420100",
      "cityCode": "420112",
      "createTime": "2013-09-29 15:19:09",
      "orgCage": "0",
      "orgCode": "F6C68AAFA3BA437CE040007F01001D3D",
      "orgId": "F6C68AAFA3B9437CE040007F01001D3D",
      "orgName": "凌云小学",
      "orgPic": "/uploads/avatar/data/F6C68AAFA3B9437CE040007F01001D3D_180x180.jpg",
      "orgType": "3",
      "provinceCode": "420000"
   }
}

4、微网站(平台/学校)最新资讯列表

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://opengate.huijiaoyun.com/portal/api/mobilenewestcontentlist
请求方式	POST
格式	json
是否需要鉴权	是
请求数限制	否
接口方向	第三方应用>开放平台

参数说明

序号	字段名	约束	位置	类型	长度	说明
1	schoolid	必选	Body(json)	string	-	该平台的所对应的编码code或该学校所对应的机构id
2	Token	可选	Body(json)	string	-	作为微网站独有接口的标识，可选填项（默认为'weiwz'）
3	pagesize	可选	Body(json)	string	-	所要获取的资讯的条数默认为3条

返回说明

序号	字段名	约束	类型	长度	说明
1	retCode	可选	string	-	返回的编码标识（判断返回正确或错误的标识
2	result	可选	string	-	返回的是个json数组，是想要的数据信息
2.1	lists	可选	string	-	返回的是个json数组，是想要的数据信息
2.1.1	id	可选	string	-	返回该条资讯的id
2.1.2	title	可选	string	-	返回该条资讯的标题
2.1.3	content	可选	string	-	返回该条资讯的内容
2.1.4	categoryid	可选	string	-	返回该条资讯所在的分类栏目id
2.1.5	userid	可选	string	-	返回所编辑该条资讯的用户id
2.1.6	username	可选	string	-	返回编辑该条资讯的用户名
2.1.7	schoolid	可选	string	-	返回平台编码或学校id
2.1.8	schoolname	可选	string	-	返回平台名称或学校名称
2.1.9	publishdate	可选	string	-	返回编辑该资讯的时间
2.1.10	company	可选	string	-	返回发布单位
2.1.11	categoryname	可选	string	-	返回该资讯所在的分类的名称
2.1.12	clienttype	可选	string	-	终端类型(0电脑端，1移动端)）
2.1.13	fromid	可选	string	-	所投稿的原始id
2.1.14	showhome	可选	string	-	是否推荐到首页（1推荐0不推荐）
2.1.15	ousernamestr	可选	string	-	原始作者
2.1.16	contributeid	可选	string	-	投稿ID

示例

							请求报文：
{
	"schoolid": "888888",
	"token": "weiwz",
	"pagesize":"3"
}
应答报文：
{
	"retCode": "000000",
	"result": {
		"lists": [{
			"id": 359482,
			"title": "\u7435\u7436\u884c-\u767d\u5c45\u6613",
			"content": null,
			"link": null,
			"categoryid": null,
			"modeid": null,
			"listorder": null,
			"status": null,
			"userid": null,
			"username": null,
			"schoolid": null,
			"schoolname": null,
			"company": null,
			"publishdate": 1519710438,
			"view_count": null,
			"categoryname": null,
			"provinceCode": null,
			"cityCode": null,
			"areaCode": null,
			"mongoId": null,
			"clienttype": null,
			"fromid": null,
			"fromtype": null,
			"orgtype": null,
			"isshow": 1,
			"oldid": null,
			"ousername": null,
			"ofromtype": null,
			"ofromid": null,
			"textcover": null,
			"istop": null,
			"showhome": null,
			"plateformcode": null,
			"isrecommend": null,
			"isclassbrand": null,
			"ousernamestr": null,
			"contributeid": null,
			"brandsynchroid": null,
			"hnauthor": null,
			"hnsource": null,
			"hneditor": null,
			"hnfilenumber": null,
			"atta

5、通过机构栏目id获取学校资讯列表接口

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://opengate.huijiaoyun.com/portal/api/getcontentlist
请求方式	POST
格式	json
是否需要鉴权	是
请求数限制	否
接口方向	第三方应用>开放平台

参数说明

序号	字段名	约束	位置	类型	长度	说明
1	schoolid	必选	Body(json)	string	-	学校id
2	total	可选	Body(json)	string	-	返回总数
2	categoryid	可选	Body(json)	string	-	类别id
3	result	必选	Body(json)	string	-	返回信息
3	categoryname	可选	Body(json)	string	-	类别名称
4	id	可选	Body(json)	string	-	资讯id
5	isshow	可选	Body(json)	string	-	是否显示
6	page	可选	Body(json)	string	-	页数
7	pagesize	可选	Body(json)	string	-	一页的数量
8	orderby	可选	Body(json)	string	-	排序字段
9	order	可选	Body(json)	string	-	desc，asc，升序还是降序

返回说明

序号	字段名	约束	类型	长度	说明
1	retCode	必选	string	-	返回码，000000，000012

示例

							请求报文：
{
    "retCode": "000000",
    "total": 52,
    "result": [
        {
            "id": 360580,
            "title": "交话费",
            "categoryid": 15998,
            "modeid": 1,
            "publishdate": 1531884788,
            "isshow": 1,
            "pic": null
        },
        {
            "id": 360579,
            "title": "我的文章",
            "categoryid": 15994,
            "modeid": 1,
            "publishdate": 1531882342,
            "isshow": 1,
            "pic": "school/album/2018/0718/159/5b4eab56d5ee0.jpg_200x200.jpg"
        },
        {
            "id": 360577,
            "title": "请客也有大忌",
            "categoryid": 15994,
            "modeid": 1,
            "publishdate": 1531880593,
            "isshow": 1,
            "pic": "school/album/2018/0718/237/5b4ea4786aab3.jpg_200x200.jpg"
        },
        {
            "id": 360576,
            "title": "链接测试",
            "link": "http1://",
            "categoryid": 15994,
            "modeid": 3,
            "publishdate": 1531822475,
            "isshow": 1,
            "pic": null
        },
        {
            "id": 360575,
            "title": "我是谁",
            "link": "http://baidu.com",
            "categoryid": 15994,
            "modeid": 3,
            "publishdate": 1531822378,
            "isshow": 1,
            "pic": null
        },
        {
            "id": 360574,
            "title": "链接模型，点击即跳转",
            "link": "http://jd.com",
            "categoryid": 23157,
            "modeid": 3,
            "publishdate": 1531822288,
            "isshow": 1,
            "pic": null
        },
        {
            "id": 360573,
            "title": "一个人吃多单调，弄不好会得罪人",
            "categoryid": 23156,
            "modeid": 2,
            "publishdate": 1531822241,
            "isshow": 1,
            "pic": "school/album/2018/0717/103/5b4dc00a446e2.jpg_200x200.jpg"
        },
        {
            "id": 360572,
            "title": "吃有这么重要？吃真的很重要。",
            "categoryid": 23155,
            "modeid": 1,
            "publishdate": 1531822032,
            "isshow": 1,
            "pic": null
        },
        {
            "id": 360571,
            "title": "春秋时，郑国和宋国打起来",
            "categoryid": 23154,
            "modeid": 1,
            "publishdate": 1531821910,
            "isshow": 1,
            "pic": "school/album/2018/0717/113/5b4dbf442ceec.jpg_200x200.jpg"
        },
        {
            "id": 360570,
            "title": "那个电话",
            "categoryid": 15998,
            "modeid": 1,
            "publishdate": 1531821426,
            "isshow": 1,
            "pic": "school/album/2018/0717/242/5b4dbd5764be1.png_200x200.png"
        }
    ],
    "message": "调用成功"
}
应答报文：
{
    "retCode": "000000",
    "total": 52,
    "result": [
        {
            "id": 360580,
            "title": "交话费",
            "categoryid": 15998,
            "modeid": 1,
            "publishdate": 1531884788,
            "isshow": 1,
            "pic": null
        },
        {
            "id": 360579,
            "title": "我的文章",
            "categoryid": 15994,
            "modeid": 1,
            "publishdate": 1531882342,
            "isshow": 1,
            "pic": "school/album/2018/0718/159/5b4eab56d5ee0.jpg_200x200.jpg"
        },
        {
            "id": 360577,
            "title": "请客也有大忌",
            "categoryid": 15994,
            "modeid": 1,
            "publishdate": 1531880593,
            "isshow": 1,
            "pic": "school/album/2018/0718/237/5b4ea4786aab3.jpg_200x200.jpg"
        },
        {
            "id": 360576,
            "title": "链接测试",
            "link": "http1://",
            "categoryid": 15994,
            "modeid": 3,

6、根据区域编码获取区域信息

根据区域编码获取区域信息

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://opengate.huijiaoyun.com/baseInfo/selectAreaInfo?accessToken=ACCESS_TOKEN
请求方式	post
格式	json
是否需要鉴权	是
请求数限制	否
接口方向	第三方应用>开放平台

参数说明

序号	字段名	约束	位置	类型	长度	说明
1	areaCode	必选	Body(json)	String	32	区域编码，多个区域编码之间使用逗号分开，一次最多查询1000个区域信息

返回说明

序号	字段名	约束	类型	长度	说明
1	retCode	必选	String	6	返回码
2	retDesc	必选	String	100	返回码描述
3	count	必选	String	8	总记录条数
4	list	必选	JSON对象	-	区域信息数组
4.1	areaCode	必选	String	32	区域编码
4.2	areaName	必选	String	32	区域名称
4.3	parentId	必选	String	32	上级区域编码
4.4	createTime	可选	date	-	创建时间
4.5	createUser	可选	string	32	创建者
4.6	note	可选	string	32	备注
4.7	pkid	必选	string	32	区域id
4.8	showIndex	必选	int	10	显示顺序
4.9	state	必选	string	2	状态
4.10	updateTime	可选	date	-	更新时间
4.11	updateUser	可选	string	32	更新作者
4.12	weather	可选	string	32	天气预报编码

示例

							请求报文：
{
"areaCode":"420000"
}
返回报文：
{
    "result": "000000",
    "desc": "success",
    "count": 2,
    "list": [
        {
            "areaCode": "420000",
            "areaName": "湖北省",
            "createTime": null,
            "createUser": "",
            "note": "",
            "parentId": "0",
            "pkid": "420000",
            "showIndex": 908,
            "state": "0",
            "updateTime": null,
            "updateUser": "",
            "weather": ""
        },
        {
            "areaCode": "420100",
            "areaName": "武汉市",
            "createTime": null,
            "createUser": "",
            "note": "",
            "parentId": "420000",
            "pkid": "420100",
            "showIndex": 2829,
            "state": "0",
            "updateTime": null,
            "updateUser": "",
            "weather": ""
        }
    ]
}

7、获取下级机构列表

根据机构Id获取下级机构和学校的列表信息

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://opengate.huijiaoyun.com/baseInfo/org/getOrgList?accessToken=ACCESS_TOKEN
请求方式	POST
格式	json
是否需要鉴权	是
请求数限制	是
接口方向	第三方应用>开放平台

参数说明

序号	字段名	约束	位置	类型	长度	说明
1	orgId	必选	Body(json)	string	-	机构Id
2	type	必选	Body(json)	string	-	机构类型;0-全部；1-学校；2-机构
3	start	必选	Body(json)	string	-	获取开始记录下标，从1开始
4	end	必选	Body(json)	string	-	获取结束记录下标

返回说明

序号	字段名	约束	类型	长度	说明
1	retCode	可选	string	-	返回码
2	retDesc	可选	string	-	返回码描述
3	orgList	可选	list	-	机构信息列表
3.1	orgId	可选	string	-	机构Id
3.2	orgName	可选	string	-	机构名称
3.3	provinceCode	可选	string	-	所属省份
3.4	cityCode	可选	string	-	所属城市
3.5	areaCode	可选	string	-	所属区县
3.6	orgCage	可选	string	-	机构类别 0：小学，小学一年级到六年级 1：初中，初中一年级到初中三年级 2：高中，高中一年级到高中三年级 3：完中，初中一年级到高中三年级 4：机构，电教馆或教育局 5：教学点，小学一年级到六年级 6：九年一贯制，小学一年级到初中三年级 7：十二年一贯制，小学一年级到高中三年级 8：高等教育 9：其他教育类学校 10：中职 11：高职 12: 学前教育
3.7	orgCode	可选	string	-	机构唯一代码
4	start	可选	Integer	-	获取开始位置，从1开始
5	count	可选	Integer	-	总记录条数
6	end	可选	Integer	-	获取结束位置

示例

							请求报文：
{
    "orgId":"0D4A8B0807BDBDA1E050A8C033C83692",
     "type":"1",
    "start":"1",
    "end":"2"
}

应答报文：
{
    "retCode": "000000",
    "start": 1,
    "end": 2,
    "count": 24,
    "retDesc": "success",
    "orgList": [
        {
            "areaCode": "310100",
            "cityCode": "310100",
            "orgCage": "0",
            "orgCode": "9caa187c84f04c8db50f7123c5408eb6",
            "orgId": "0d38c686eebd46fa9c1ff02d3f7139fb",
            "orgName": "test8900",
            "provinceCode": "310000"
        }
    ]
}

序号	字段名	约束	类型	长度	说明
1	msgType	必选	String	10	消息类型，此时固定为：text
1.1	text	必选	Json	-	text消息体
1.1.1	content	必选	String		消息内容

序号	字段名	约束	类型	长度	说明
1	msgType	必选	String	10	消息类型，此时固定为：oa
2	busiId	必选	String	-	该条oa消息在业务系统对应的id
3	pcUrl	必选	String		消息点击链接地址
4	appUrl	必选	String		移动客户端点击消息时跳转到的H5地址
5	oa	必选	Json	-	oa类型消息体
5.1	head	必选	Json	255	消息头部Json
5.1.1	text	必选	String	255	消息的头部标题
5.1.2	bgColor	可选	String		消息头部的背景颜色。长度限制为8个英文字符，其中前2为表示透明度，后6位表示颜色值。不要添加0x。默认值：FFCC0000
5.2	body	可选	Json		消息体
5.2.1	title	可选	String		消息体的标题
5.2.2	content	可选	String		消息体的正文
5.2.3	imageUrl	可选	String		消息体中的图片url
5.2.4	fileCount	可选	String		自定义的附件数目。此数字仅供显示，不作验证
5.2.5	author	可选	String		自定义的作者名字
5.2.6	form	可选	Json数组		消息体的表单，最多6个
5.2.7	key	可选	String		消息体的关键字
5.2.8	value	可选	String		消息体的关键字对应的值

开发者登录

机构基本信息API

1、获取机构管理员列表

前置条件

请求说明

参数说明

返回说明

示例

2、微网站平台首页轮播图片

前置条件

请求说明

参数说明

返回说明

示例

3、获取机构基本信息

前置条件

请求说明

参数说明

返回说明

示例

4、微网站(平台/学校)最新资讯列表

前置条件

请求说明

参数说明

返回说明

示例

5、通过机构栏目id获取学校资讯列表接口

前置条件

请求说明

参数说明

返回说明

示例

6、根据区域编码获取区域信息

前置条件

请求说明

参数说明

返回说明

示例

7、获取下级机构列表

前置条件

请求说明

参数说明

返回说明

示例

参数说明

示例

参数说明

示例

参数说明