主要使用場景:組織機(jī)構(gòu)接口7.0
該接口能獲取到校區(qū)、學(xué)段、年級、班級的詳情
獲取接口訪問憑證:accessToken
url | https://api.tze.cn/user/openapi/org/get-edu-info?org_id=123&accessToken={{accessToken}} |
請求方式 | get |
是否需要鑒權(quán) | 是 |
請求數(shù)限制 | 否 |
接口方向 | 第三方應(yīng)用->開放平臺 |
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
org_id |
必選 |
string |
節(jié)點id |
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
code |
必選 |
string |
結(jié)果編碼,000000:成功, 100001:失敗 | |
2 |
message |
必選 |
string |
結(jié)果描述 | |
3 |
result |
必選 |
string |
結(jié)果數(shù)據(jù) | |
3.1 |
org_id |
必選 |
string |
部門id | |
3.1 |
top_org_id |
必選 |
string |
學(xué)校id | |
3.2 |
grade_number |
可選 |
Int |
年級70版本編號(班級、年級時返回) | |
3.2 |
platform_org_id |
必選 |
string |
原平臺組織id | |
3.3 |
graduation_header_teacher |
可選 |
array |
班主任數(shù)據(jù),(班級畢業(yè)時返回) | |
3.3 |
platform_code |
必選 |
string |
原平臺組織平臺碼 | |
3.4 |
org_name |
必選 |
string |
組織名稱 | |
3.5 |
org_short_name |
必選 |
string |
組織簡稱 | |
3.6 |
org_type |
必選 |
string |
組織類型(3:校區(qū),5:學(xué)段,6:年級,7班級) | |
3.7 |
create_user_id |
必選 |
string |
創(chuàng)建者id | |
3.8 |
createtime |
必選 |
string |
創(chuàng)建時間 | |
3.9 |
updatetime |
必選 |
string |
更新時間 | |
3.11 |
parent_id |
必選 |
string |
父級節(jié)點id | |
3.12 |
group_id |
可選 |
string |
群組id | |
3.13 |
status |
必選 |
string |
狀態(tài),0:組織未激活,1:正常,2:解散,3:鎖定 | |
3.14 |
certification |
必選 |
string |
認(rèn)證(0:未認(rèn)證,1:已認(rèn)證) | |
3.15 |
flag |
必選 |
string |
標(biāo)記(0:正常,1:演示,2:測試) | |
3.16 |
level |
必選 |
string |
業(yè)務(wù)等級(0:無等級,1:等級一,2:等級二) | |
3.17 |
verify_mode |
必選 |
string |
成員加入模式(1允許加入,2不允許加入) | |
3.18 |
top_school_id |
必選 |
string |
校區(qū)id(班級、年級、學(xué)段、校區(qū)時返回) | |
3.19 |
class_number |
可選 |
Int |
班級編號(班級時返回) | |
3.21 |
grade_rule_number |
可選 |
Int |
年級的60版本編號(班級、年級時返回) | |
3.22 |
period_type |
可選 |
Int |
學(xué)段類型(班級、年級、學(xué)段時返回) | |
3.23 |
grade_year |
可選 |
Int |
入學(xué)年份(年級、班級時返回) | |
3.24 |
grade_system |
可選 |
string |
年級的學(xué)制類型(年級、班級時返回) | |
3.25 |
grade_system_name |
可選 |
string |
學(xué)制名稱,(年級、班級時返回) | |
3.26 |
avatar |
可選 |
string |
頭像地址,(校區(qū)、班級時返回) | |
3.27 |
graduation_is |
可選 |
int |
是否已畢業(yè),(0未畢業(yè),1已畢業(yè);年級、班級時返回) | |
3.28 |
graduation_year |
可選 |
string |
畢業(yè)年份,(年級、班級時返回) | |
3.29 |
graduation_school_name |
可選 |
string |
畢業(yè)時的學(xué)校名稱,(班級畢業(yè)時返回) | |
3.31 |
top_org_name |
可選 |
string |
學(xué)校的名稱 | |
3.32 |
org_coding |
可選 |
string |
班級編碼(班級時返回) |
請求示例 http://api.tze.cn/user/openapi/org/get-edu-info?org_id=123&accessToken={{accessToken}} 返回示例 { "code": "000000", "message": "請求成功", "result": { "org_id": "c2d2a224-5a9a-11e9-9c82-0200f7b88099", "platform_org_id": "c2d2a224-asas-11e9-9c82-0200f7b88099", "platform_code": "999999", "org_name": "校區(qū)一", "org_short_name": "校區(qū)一", "org_type": "3", "create_user_id": "af144ae4-cccc-11e9-9c82-0200f7b88099", "createtime": "1554795635", "updatetime": "1555126603", "status": "1", "certification": "0", "flag": "0", "level": "0", "verify_mode": "0", "top_org_id": "c2d2a224-dddd-11e9-9c82-0200f7b88099", "parent_id": "c2d2a224-dddd-11e9-9c82-0200f7b88099", "top_school_id": "c2d2a224-5a9a-11e9-9c82-0200f7b88099", "top_org_name": "xxxx學(xué)校", } }
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時固定為:text |
1.1 |
text |
必選 |
Json |
- |
text消息體 |
1.1.1 |
content |
必選 |
String |
消息內(nèi)容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時固定為:link |
2 |
link |
必選 |
Json |
- |
link消息體 |
2.1 |
pcUrl |
必選 |
String |
PC端消息點擊鏈接地址 |
|
2.2 |
appUrl |
必選 |
String |
移動客戶端點擊消息時跳轉(zhuǎn)到的H5地址 |
|
2.3 |
title |
必選 |
String |
消息標(biāo)題 |
|
2.4 |
busiId |
必選 |
String |
對應(yīng)業(yè)務(wù)的id |
|
2.5 |
content |
必選 |
String |
消息描述 |
|
2.6 |
picUrl |
必選 |
String |
圖文消息的圖片鏈接,支持JPG、PNG格式,較好的效果為大圖640*320,小圖80*80。如不填,在客戶端不顯示圖片 |
{ "msgtype": "link", "link": { "pcUrl": "http://www.baidu.com", "appUrl": "http://www.baidu.com", "picUrl": "http://xxx.yyy.com/zzz.jpg", "content": "百度一下", "title": "百度", "busiId":"AQWER1234" } }
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時固定為:oa |
2 |
busiId |
必選 |
String |
- |
該條oa消息在業(yè)務(wù)系統(tǒng)對應(yīng)的id |
3 |
pcUrl |
必選 |
String |
消息點擊鏈接地址 |
|
4 |
appUrl |
必選 |
String |
移動客戶端點擊消息時跳轉(zhuǎn)到的H5地址 |
|
5 |
oa |
必選 |
Json |
- |
oa類型消息體 |
5.1 |
head |
必選 |
Json |
255 |
消息頭部Json |
5.1.1 |
text |
必選 |
String |
255 |
消息的頭部標(biāo)題 |
5.1.2 |
bgColor |
可選 |
String |
消息頭部的背景顏色。長度限制為8個英文字符,其中前2為表示透明度,后6位表示顏色值。不要添加0x。默認(rèn)值:FFCC0000 |
|
5.2 |
body |
可選 |
Json |
消息體 |
|
5.2.1 |
title |
可選 |
String |
消息體的標(biāo)題 |
|
5.2.2 |
content |
可選 |
String |
消息體的正文 |
|
5.2.3 |
imageUrl |
可選 |
String |
消息體中的圖片url |
|
5.2.4 |
fileCount |
可選 |
String |
自定義的附件數(shù)目。此數(shù)字僅供顯示,不作驗證 |
|
5.2.5 |
author |
可選 |
String |
自定義的作者名字 |
|
5.2.6 |
form |
可選 |
Json數(shù)組 |
消息體的表單,最多6個 |
|
5.2.7 |
key |
可選 |
String |
消息體的關(guān)鍵字 |
|
5.2.8 |
value |
可選 |
String |
消息體的關(guān)鍵字對應(yīng)的值 |