主要使用場景:組織機構(gòu)接口7.0
該接口能獲取機構(gòu),學校,企業(yè),工作室等具有獨立性質(zhì)的組織詳情
獲取接口訪問憑證:accessToken
url | https://api.tze.cn/user/openapi/org/get-org-info?org_id=123&accessToken={{accessToken}} |
請求方式 | get |
是否需要鑒權(quán) | 是 |
請求數(shù)限制 | 否 |
接口方向 | 第三方應(yīng)用->開放平臺 |
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
org_id |
必選 |
string |
機構(gòu)、學校等組織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 |
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": "機構(gòu)","2": "學校","3": "校區(qū)","4": "部門","5": "學段","6": "年級","7": "班級","8": "企業(yè)機構(gòu)","9": "教學工作室","10": "平臺") | |
3.7 |
create_user_id |
必選 |
string |
創(chuàng)建者id | |
3.8 |
createtime |
必選 |
string |
創(chuàng)建時間 | |
3.9 |
updatetime |
必選 |
string |
更新時間 | |
3.11 |
city_code |
必選 |
string |
地理城市 | |
3.12 |
area_code |
必選 |
string |
地理區(qū)域 | |
3.13 |
status |
必選 |
string |
狀態(tài),0:組織未激活,1:正常,2:解散,3:鎖定 | |
3.14 |
certification |
必選 |
string |
認證(0:未認證,1:已認證) | |
3.15 |
org_level |
可選 |
string |
行政等級,是機構(gòu)、學校類型時返回 “1”: “國家” “2”: “省級” “3”: “地級” “4”: “縣級” “5”: “鄉(xiāng)級” | |
3.16 |
org_level_code |
必選 |
string |
行政區(qū)劃,是機構(gòu)、學校類型時返回 | |
3.17 |
org_parent_id |
可選 |
string |
直屬上級機構(gòu)id,是機構(gòu)、學校類型認證的組織才能有(比如A學校的上級是AA機構(gòu),AA機構(gòu)的上級是AAA機構(gòu)) | |
3.18 |
org_address |
可選 |
string |
組織的聯(lián)系地址 | |
3.19 |
org_category |
可選 |
int |
組織的類別(org_type為0時,機構(gòu):0: "行政類",1: "電教類", 2: "裝備類","3": "黨政類","99": "教育局" org_type為1時,學校:0: "小學",1: "初中",2: "高中",3: "完中" ,5: "教學點",6: "九年一貫制",7: "十二年一貫制", 8: "高等教育",9: "其它教育類學校",10: "中職",11:"高職",12: "學前教育"),未設(shè)置時為空字符串 | |
3.20 |
org_category_title |
可選 |
string |
組織的類別名稱(org_type為0時,機構(gòu):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 |
機構(gòu)、學校屬性 - 短編碼 | |
3.24 |
org_has_child |
可選 |
string |
機構(gòu)屬性 - 機構(gòu)是否存在下級組織(1是,0否) |
請求示例 http://api.tze.cn/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" ] } } }
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
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 |
消息標題 |
|
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 |
消息的頭部標題 |
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 |
自定義的附件數(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)的值 |