主要使用場(chǎng)景:系統(tǒng)字典類
查詢自定義學(xué)科列表
獲取接口訪問憑證:accessToken
url | https://api.tze.cn/user/openapi/subject/get-custom-subject?accessToken={{accessToken}} |
請(qǐng)求方式 | get |
是否需要鑒權(quán) | 是 |
請(qǐng)求數(shù)限制 | 否 |
接口方向 | 第三方應(yīng)用->開放平臺(tái) |
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
top_org_id |
必選 |
string |
學(xué)校編號(hào) 必傳 | |
2 |
school_period |
可選 |
string |
學(xué)段類型 以,連接 不傳查所有學(xué)段 | |
3 |
page |
可選 |
string |
頁碼 不傳默認(rèn)1 | |
4 |
page_size |
可選 |
int |
每頁查詢數(shù)量 不傳默認(rèn)100 |
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
code |
必選 |
string |
結(jié)果編碼 | |
2 |
message |
必選 |
string |
結(jié)果描述 | |
3 |
result |
必選 |
json |
結(jié)果對(duì)象 | |
3.1 |
count |
必選 |
string |
學(xué)科數(shù)量 | |
3.2 |
page |
必選 |
string |
當(dāng)前頁碼 | |
3.3 |
page_size |
必選 |
string |
每頁數(shù)量 | |
3.4 |
list |
必選 |
json |
學(xué)科列表 | |
3.4.1 |
subject_id |
必選 |
string |
學(xué)科編號(hào) | |
3.4.2 |
parent_subject_id |
必選 |
string |
父級(jí)學(xué)科(預(yù)留) | |
3.4.3 |
org_id |
必選 |
string |
學(xué)校id | |
3.4.4 |
school_period |
必選 |
string |
學(xué)段,多個(gè)逗號(hào)分隔 | |
3.4.5 |
subject_name |
必選 |
string |
學(xué)科名字 | |
3.4.6 |
subject_alias |
必選 |
string |
學(xué)科別名 | |
3.4.7 |
subject_type |
必選 |
string |
學(xué)科類型 | |
3.4.8 |
status |
必選 |
int |
狀態(tài) | |
3.4.9 |
createtime |
必選 |
int |
創(chuàng)建時(shí)間 | |
3.4.10 |
updatetime |
必選 |
int |
更新時(shí)間 |
請(qǐng)求示例 http://api.tze.cn/user/openapi/subject/get-custom-subject?top_org_id=***&school_period=***&accessToken={{accessToken}} 返回示例 { "code": "000000", "message": "查詢成功", "result": { "count": 8, "page": 1, "page_size": 3, "list": [ { "org_id": "012b5b648d8211e9a0210200f73e4533", "status": 0, "createtime": 1583458216, "subject_id": "08d1d0ba5f4a11eabcce0200f7010548", "updatetime": 1583460162, "introduction": "", "subject_name": "自定義學(xué)科1", "subject_type": 2, "platform_code": "", "school_period": "0,1", "subject_alias": "自定義學(xué)科1", "parent_subject_id": "" }, { "org_id": "012b5b648d8211e9a0210200f73e4533", "status": 0, "createtime": 1619160997, "subject_id": "0c89cee0a40111eb99042ad18a2581e3", "updatetime": 1626412070, "introduction": "", "subject_name": "理科綜合", "subject_type": 2, "platform_code": "888880", "school_period": "1,2", "subject_alias": "理綜", "parent_subject_id": "" }, { "org_id": "012b5b648d8211e9a0210200f73e4533", "status": 0, "createtime": 1619161007, "subject_id": "12273720a40111eb80af2ad18a2581e3", "updatetime": 1626412092, "introduction": "", "subject_name": "文科綜合", "subject_type": 2, "platform_code": "888880", "school_period": "1,2", "subject_alias": "文綜", "parent_subject_id": "" } ] } }
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:text |
1.1 |
text |
必選 |
Json |
- |
text消息體 |
1.1.1 |
content |
必選 |
String |
消息內(nèi)容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:link |
2 |
link |
必選 |
Json |
- |
link消息體 |
2.1 |
pcUrl |
必選 |
String |
PC端消息點(diǎn)擊鏈接地址 |
|
2.2 |
appUrl |
必選 |
String |
移動(dòng)客戶端點(diǎn)擊消息時(shí)跳轉(zhuǎn)到的H5地址 |
|
2.3 |
title |
必選 |
String |
消息標(biāo)題 |
|
2.4 |
busiId |
必選 |
String |
對(duì)應(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" } }
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:oa |
2 |
busiId |
必選 |
String |
- |
該條oa消息在業(yè)務(wù)系統(tǒng)對(duì)應(yīng)的id |
3 |
pcUrl |
必選 |
String |
消息點(diǎn)擊鏈接地址 |
|
4 |
appUrl |
必選 |
String |
移動(dòng)客戶端點(diǎn)擊消息時(shí)跳轉(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個(gè)英文字符,其中前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ù)字僅供顯示,不作驗(yàn)證 |
|
5.2.5 |
author |
可選 |
String |
自定義的作者名字 |
|
5.2.6 |
form |
可選 |
Json數(shù)組 |
消息體的表單,最多6個(gè) |
|
5.2.7 |
key |
可選 |
String |
消息體的關(guān)鍵字 |
|
5.2.8 |
value |
可選 |
String |
消息體的關(guān)鍵字對(duì)應(yīng)的值 |