主要使用場(chǎng)景:系統(tǒng)字典類(lèi)
查詢(xún)基礎(chǔ)學(xué)科列表
獲取接口訪問(wèn)憑證:accessToken
url | https://api.tze.cn/user/openapi/subject/get-system-subject?accessToken={{accessToken}} |
請(qǐng)求方式 | get |
是否需要鑒權(quán) | 是 |
請(qǐng)求數(shù)限制 | 否 |
接口方向 | 第三方應(yīng)用->開(kāi)放平臺(tái) |
序號(hào) | 字段名 | 約束 | 類(lèi)型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
top_org_id |
可選 |
string |
學(xué)校編號(hào) 不傳查平臺(tái)級(jí)學(xué)科 | |
2 |
school_period |
可選 |
string |
學(xué)段類(lèi)型 以,連接 不傳查所有學(xué)段 | |
3 |
page |
可選 |
string |
頁(yè)碼 不傳默認(rèn)1 | |
4 |
page_size |
可選 |
int |
每頁(yè)查詢(xún)數(shù)量 不傳默認(rèn)100 |
序號(hào) | 字段名 | 約束 | 類(lèi)型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
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)前頁(yè)碼 | |
3.3 |
page_size |
必選 |
string |
每頁(yè)數(shù)量 | |
3.4 |
list |
必選 |
json |
學(xué)科列表 | |
3.4.1 |
subject_id |
必選 |
string |
學(xué)科編號(hào) | |
3.4.2 |
school_period |
必選 |
string |
學(xué)段,多個(gè)逗號(hào)分隔 | |
3.4.3 |
subject_name |
必選 |
string |
學(xué)科名字 | |
3.4.4 |
subject_alias |
必選 |
string |
學(xué)科別名 |
請(qǐng)求示例 http://api.tze.cn/user/openapi/subject/get-system-subject?top_org_id=***&school_period=***&accessToken={{accessToken}} 返回示例 { "code": "000000", "message": "查詢(xún)成功", "result": { "count": 11, "page": 1, "page_size": 3, "list": [ { "subject_id": "jcsub18", "subject_type": "1", "subject_name": "美術(shù)", "subject_alias": "美術(shù)" }, { "subject_id": "jcsub20", "subject_type": "1", "subject_name": "音樂(lè)", "subject_alias": "音樂(lè)" }, { "subject_id": "jcsub24", "subject_type": "1", "subject_name": "幼教健康", "subject_alias": "幼教健康" } ] }, "_timestamp": "1655112323.6695", "_runtime": "0.0803" }
序號(hào) | 字段名 | 約束 | 類(lèi)型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類(lèi)型,此時(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) | 字段名 | 約束 | 類(lèi)型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類(lèi)型,此時(shí)固定為:link |
2 |
link |
必選 |
Json |
- |
link消息體 |
2.1 |
pcUrl |
必選 |
String |
PC端消息點(diǎn)擊鏈接地址 |
|
2.2 |
appUrl |
必選 |
String |
移動(dòng)客戶(hù)端點(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。如不填,在客戶(hù)端不顯示圖片 |
{ "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) | 字段名 | 約束 | 類(lèi)型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類(lèi)型,此時(shí)固定為:oa |
2 |
busiId |
必選 |
String |
- |
該條oa消息在業(yè)務(wù)系統(tǒng)對(duì)應(yīng)的id |
3 |
pcUrl |
必選 |
String |
消息點(diǎn)擊鏈接地址 |
|
4 |
appUrl |
必選 |
String |
移動(dòng)客戶(hù)端點(diǎn)擊消息時(shí)跳轉(zhuǎn)到的H5地址 |
|
5 |
oa |
必選 |
Json |
- |
oa類(lèi)型消息體 |
5.1 |
head |
必選 |
Json |
255 |
消息頭部Json |
5.1.1 |
text |
必選 |
String |
255 |
消息的頭部標(biāo)題 |
5.1.2 |
bgColor |
可選 |
String |
消息頭部的背景顏色。長(zhǎng)度限制為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)的值 |