和教育開放平臺接口協(xié)議_第1頁
和教育開放平臺接口協(xié)議_第2頁
和教育開放平臺接口協(xié)議_第3頁
和教育開放平臺接口協(xié)議_第4頁
和教育開放平臺接口協(xié)議_第5頁
已閱讀5頁,還剩129頁未讀 繼續(xù)免費閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認(rèn)領(lǐng)

文檔簡介

和教育開放平臺接口協(xié)議中國移動通信集團廣東有限公司第13頁共13頁和教育開放平臺接口協(xié)議版本:v2.16中國移動通信集團廣東有限公司編制:卜時熙 審批: 聲明:本文件所有權(quán)和解釋權(quán)歸中國移動通信集團廣東有限公司所有,未經(jīng)書面許可,不得復(fù)制或向第三方公開。

文檔修改歷史記錄日期版本作者修改內(nèi)容2014-3-20V1.08卜時熙初始版本2014-4-10V2.00黃振標(biāo)2014-5-07V2.01黃振標(biāo)1、增加接口示例說明及增字段參數(shù)說明2、增加家校圈微博上傳接口3、獲取學(xué)生信息接口返回值補充學(xué)校ID4、微博發(fā)布接口刪除參數(shù)多余參:OtherPathAndName、Uofilename、Type5、刪除了第三方應(yīng)用接口回調(diào)的不必要參數(shù)。2014-5-19V2.02黃振標(biāo)增加OEM類型的服務(wù)消息接口2014-6-18V2.03黃振標(biāo)調(diào)整應(yīng)用消息和OEM消息接口參數(shù)類型,并增加查詢消息了刪除消息接口增加科目接口增加基礎(chǔ)數(shù)據(jù)增量接口(3.3章節(jié))2014-7-06V2.04黃振標(biāo)1、應(yīng)用消息、OEM消息的查詢及刪除接口增加地市ID參數(shù)。2014-07-24V2.05黃振標(biāo)教師信息查詢接口增加學(xué)校角色及色名名稱字段(3.2.4,3.2.11)2014-11-13V2.06卜時熙1、CHK_OAUTH接口增加了Bank(年級編號),AccountId(賬號編號)。2、QRY_STUPRT_BY_CLASS,QRY_PARENT_INFO,QRY_STUDENT_INFO,QRY_PARENT_UPDATE接口增加了AccountId(賬號編號)。2014-11-18V2.07卜時熙SEND_SINGLE_SMS,SEND_BATCH_SMS接口增加Token(用戶登錄時的)參數(shù)。增加QRY_SMS_NOREAD(獲取短信上行未讀內(nèi)容接口)。增加QRY_SMS_READ(獲取短信上行內(nèi)容接口)。增加SEND_CAPTCHA_SMS(業(yè)務(wù)開通驗證碼下發(fā)接口)。增加PUT_CAPTCHA_ORDER(驗證碼開通業(yè)務(wù)接口)。2014-12-25V2.08卜時熙修改QRY_SMS_NOREAD(獲取短信上行未讀內(nèi)容接口),QRY_SMS_READ(獲取短信上行內(nèi)容接口),增加一個OthMsgId字段。業(yè)務(wù)訂購概要變更日志接口(QRY_CHG_MAIN),新的應(yīng)用不可再申請該接口權(quán)限。業(yè)務(wù)訂購明細(xì)變更日志接口查詢業(yè)務(wù)變動情況(QRY_CHG_DETAIL)中的LogType刪除,SchoolId變更為可選參數(shù)(如果提供學(xué)校ID,就與舊功能一樣查詢該學(xué)校的業(yè)務(wù)變更,如果不提供就查詢該地市的業(yè)務(wù)變更)。2015-02-22V2.09謝君增加CHK_OAUTH2(用戶驗證2.0接口)增加SEND_CAPTCHA_SMS2(停用)增加PUT_CAPTCHA_ORDER2(停用)增加QRY_ORDER2(查詢家長用戶訂購業(yè)務(wù)情況2.0接口)2015-06-10V2.10謝君1、增加CHECK_USER_TOKEN(用戶驗證生成TOKEN接口)2016-04-19V2.11謝君、林興用戶授權(quán)接口(CHK_OAUTH)需要增加一個學(xué)段字段(section),支持多個學(xué)段-1:無,1:幼兒園,2:小學(xué),3:初中,4:高中增加接口SEND_IM_CLS_MESSAG(發(fā)送即時消息接口)增加接口PUT_CAPTCHA_ORDER_SI(業(yè)務(wù)開通接口只針對SI開通的分成比例為15:85的業(yè)務(wù))增加SEND_BATH_KQ_THRMETAIL(考勤提問數(shù)據(jù)發(fā)送接口)2017-02-23V.2.12林興修改CHK_OAUTH2(增加section字段)2、增加QRY_BATCH_ORDER(查詢某個應(yīng)用的訂購情況)3、增加QRY_ORDER3(查詢某個用戶所有訂購關(guān)系)2017-03-10V.2.13林興1,增加QRY_NOINFO_USER(查詢無學(xué)籍用戶)2,增加SEND_CAPTCHA_SMS3(發(fā)送訂購驗證碼3.0)3,增加PUT_CAPTCHA_ORDER3(上行驗證碼開通業(yè)務(wù)3.0)2017-05-09V.2.14林興1,增加無學(xué)籍注冊組件2,修改QRY_NOINFO_USER(查詢無學(xué)籍用戶)3,修改SEND_CAPTCHA_SMS3(對無學(xué)籍用戶發(fā)送訂購驗證碼)4,修改PUT_CAPTCHA_ORDER3(對無學(xué)籍用戶上行驗證碼開通業(yè)務(wù))5,修改QRY_ORDER3(引入openid)6,修改QRY_BATCH_ORDER(引入openid)2017-05-11V.2.14謝君1.下架SEND_BATCH_KQ接口2.下架SEND_BATCH_KQ_THRMETAIL接口3.增加SEND_STU_KQ接口(學(xué)生普通考勤推送接口)4.增加SEND_REAL_KQ接口(實時考勤推送接口)5.增加QRY_YKT_ERROR_RESULT(一卡通推送失敗查詢接口)2017-07-27V.2.15林興1,SEND_BATCH_SMS增加發(fā)送人相關(guān)字段2,SEND_SINGLE_SMS增加發(fā)送人相關(guān)字段

目錄TOC\o"1-3"\h\u288331.協(xié)議編制背景 6325442.協(xié)議概述 6179052.1.第三方應(yīng)用接口使用范圍 6264972.2.消息交互實現(xiàn)與約定 7312212.2.1.請求報文 845132.2.2.響應(yīng)報文 9513.平臺能力服務(wù) 10275643.1.授權(quán)認(rèn)證 10153293.1.1.用戶驗證接口 10145813.1.2.用戶驗證2.0接口 12206323.1.3.單點登錄組件 1327613.1.4.無學(xué)籍用戶注冊組件(H5) 14172463.2.基礎(chǔ)數(shù)據(jù) 15258123.2.1.獲取地市所有鎮(zhèn)區(qū)信息接口 15237423.2.2.獲取鎮(zhèn)區(qū)所有學(xué)校信息接口 17261903.2.3.獲取學(xué)校所有班級信息接口 1889993.2.4.獲取學(xué)校所有教師信息接口 2060633.2.5.獲取某班級所有學(xué)生信息接口 21209453.2.6.獲取班級與教師關(guān)系信息接口 23208423.2.7.批量獲取某班學(xué)生及家長信息接口 25105173.2.8.獲取某學(xué)校信息接口 28157083.2.9.獲取某班級信息接口 2947683.2.10.獲取科目信息接口 30288603.2.11.獲取教師用戶信息接口 31164113.2.12.獲取家長用戶信息接口 32190973.2.13.獲取學(xué)生用戶信息接口 34246393.2.14.查詢無學(xué)籍用戶 36253763.3.基礎(chǔ)數(shù)據(jù)增量接口 3795873.3.1.獲取鎮(zhèn)區(qū)增量數(shù)據(jù)接口 37313013.3.2.獲取學(xué)校增量數(shù)據(jù)接口 39292813.3.3.獲取班級增量數(shù)據(jù)接口 4121793.3.4.獲取科目增量數(shù)據(jù)接口 43256393.3.5.獲取教師增量數(shù)據(jù)接口 44273443.3.6.獲取家長增量數(shù)據(jù)接口 46284253.3.7.獲取學(xué)生增量數(shù)據(jù)接口 48109983.3.8.獲取教師與班級關(guān)系的增量數(shù)據(jù)接口 50122723.3.9.獲取班級對應(yīng)學(xué)生增量數(shù)據(jù)接口 5113783.4.消息類接口 52158723.4.1.應(yīng)用消息接口 52227093.4.2.OEM消息接口 64114133.4.3.短信消息接口 73122663.5.家校微博圈 81102973.5.1.獲取家校圈微博記錄接口 81314443.5.2.獲取家校圈微博評論信息接口 83250463.5.3.獲取家校圈微博贊明細(xì)信息接口 85192203.5.4.家校圈微博發(fā)布接口 86313953.5.5.家校圈微博分享發(fā)布接口 88229913.5.6.家校圈微博評論接口 8991393.5.7.家校圈微博贊接口 90156133.5.8.家校圈圖片附件上傳接口 91175883.6.業(yè)務(wù)能力 92188123.6.1.家長訂購業(yè)務(wù)二次確認(rèn)短信接口 92254173.6.2.業(yè)務(wù)開通驗證碼下發(fā)接口 93270443.6.3.驗證碼開通業(yè)務(wù)接口 94140183.6.4.查詢家長用戶訂購業(yè)務(wù)情況接口 95236883.6.5.業(yè)務(wù)訂購明細(xì)變更日志接口 98314283.6.6.驗證碼開通業(yè)務(wù)接口(代理商開通類型) 10132243.6.7.查詢家長用戶訂購業(yè)務(wù)情況3.0接口 102327553.6.8.查詢應(yīng)用所有訂購關(guān)系查詢 10382103.6.9.業(yè)務(wù)開通驗證碼下發(fā)3.0 104130783.6.10.驗證碼開通業(yè)務(wù)3.0 105148713.7.成績能力 106221063.7.1.獲取學(xué)生成績接口 106228923.8.一卡通能力 108178153.8.1.學(xué)生普通考勤信息批量推送接口 108271733.8.2.消費信息批量推送接口 11096643.8.3.實時考勤信息批量推送接口 11225113.8.4一卡通推送失敗查詢接口 11484304.第三方應(yīng)用接口 116148114.1.單點登錄URL 11670764.1.1.業(yè)務(wù)描述 116231174.1.2.接口描述 116222745.附錄 117134405.1.附錄1:地市標(biāo)識列表 11710325.2.附錄2:年級編號列表 117192885.3.附錄3:密碼的加密與解密算法 118189125.4.附錄4:返回代碼說明 121118545.5.附錄5:短信模板參數(shù) 12222105.6.附錄6:開放平臺地址 122111985.6.1.服務(wù)支撐聯(lián)系方式 12244345.6.2.應(yīng)用聯(lián)調(diào)與WSDL文件 12210995.6.3.正式平臺接入 123202126.其他 12361886.1.溫馨提示 123

協(xié)議編制背景為了實現(xiàn)和教育系統(tǒng)與第三方應(yīng)用的順利對接,完成兩個獨立系統(tǒng)之間的數(shù)據(jù)交互。和教育系統(tǒng)提供相應(yīng)的數(shù)據(jù)請求接口以供第三方應(yīng)用獲取所需數(shù)據(jù)。為了規(guī)范和更好地實現(xiàn)和教育與第三方應(yīng)用的數(shù)據(jù)通信,制定此接口規(guī)范。協(xié)議概述第三方應(yīng)用接口使用范圍開放平臺將根據(jù)第三方應(yīng)用級別分類開放對應(yīng)接口權(quán)限,各類應(yīng)用可用接口明細(xì)如下:接口分類接口功能說明接口名稱應(yīng)用權(quán)限備注孵化應(yīng)用上架應(yīng)用用戶授權(quán)用戶單點登錄(教師、家長、學(xué)生)CHK_OAUTH用戶授權(quán)單點登錄基礎(chǔ)數(shù)據(jù)獲取地市所有鎮(zhèn)區(qū)信息接口QRY_TOWN不提供獲取鎮(zhèn)區(qū)所有學(xué)校信息接口QRY_BATCH_SCHOOL不提供獲取學(xué)校所有班級信息接口QRY_BATCH_CLASS不提供獲取學(xué)校所有教師信息接口QRY_SCHOOL_TEACHER獲取某班級所有學(xué)生信息接口QRY_CLASS_STUDENT獲取班級與教師關(guān)系信息接口QRY_CLASS_TEACHER批量獲取某班學(xué)生及家長信息接口QRY_STUPRT_BY_CLASS獲取某個學(xué)校信息接口QRY_SCHOOL不提供獲取某個班級信息接口QRY_CLASS獲取科目信息QRY_SUBJECT獲取教師用戶信息接口QRY_TEACHER_INFO獲取家長用戶信息接口QRY_PARENT_INFO獲取學(xué)生用戶信息接口QRY_STUDENT_INFO獲取鎮(zhèn)區(qū)變更、增量數(shù)據(jù)接口QRY_TOWN_UPDATE不提供獲取學(xué)校變更、增量數(shù)據(jù)接口QRY_SCHOOL_UPDATE不提供獲取班級變更、增量數(shù)據(jù)接口QRY_CLASS_UPDATE不提供獲取科目增量數(shù)據(jù)接口QRY_SUBJECT_UPDATE不提供獲取教師與班級關(guān)系的增量數(shù)據(jù)接口QRY_CLASS_TEACHER_UPDATE不提供獲取班級對應(yīng)學(xué)生增量數(shù)據(jù)接口QRY_CLASS_STUDENT_UPDATE不提供應(yīng)用消息向某用戶推送應(yīng)用消息接口SEND_SYS_PUBLIC_MESSAGE限制提供批量向某學(xué)校推送應(yīng)用消息接口SEND_SYS_SCH_MESSAGE限制提供批量向某年級推送應(yīng)用消息接口SEND_SYS_GRP_MESSAGE限制提供批量向某班級推送應(yīng)用消息接口SEND_SYS_CLS_MESSAGE限制提供查詢應(yīng)用消息閱讀情況接口QRY_SYS_MESSAGE限制提供刪除應(yīng)用消息接口DEL_SYS_MESSAGE限制提供發(fā)送即時消息接口SEND_IM_CLS_MESSAG限制提供OEM消息向某用戶推送OEM消息接口SEND_OEM_PUBLIC_MESSAGE限制提供批量向某學(xué)校推送OEM消息接口SEND_OEM_SCH_MESSAGE限制提供批量向某年級推送OEM消息接口SEND_OEM_GRP_MESSAGE限制提供批量向某班級推送OEM消息接口SEND_OEM_CLS_MESSAGE限制提供查詢OEM消息閱讀情況接口DEL_OEM_MESSAGE限制提供刪除OEM消息接口DEL_OEM_MESSAGE限制提供短信消息單個短信發(fā)送接口SEND_SINGLE_SMS不提供批量短信發(fā)送接口SEND_BATCH_SMS不提供查詢短信發(fā)送狀態(tài)結(jié)果接口QRY_SMS_RESULT不提供獲取短信上行未讀內(nèi)容接口QRY_SMS_NOREAD不提供獲取短信上行內(nèi)容接口QRY_SMS_READ不提供家校微博圈獲取家校圈微博記錄接口QRY_WEIBO_MSG獲取家校圈微博評論信息接口QRY_COMMENT_WEIBO_MSG獲取家校圈微博贊明細(xì)信息接口QRY_PRAISE_WEIBO_MSG家校圈微博發(fā)布接口ADD_WEIBO_MSG家校圈微博分享發(fā)布接口SHARE_WEIBO_MSG家校圈微博評論接口ADD_COMMENT_WEIBO_MSG家校圈微博贊接口ADD_PRAISE_WEIBO_MSG業(yè)務(wù)模塊查詢營銷方案信息接口(本應(yīng)用+套餐)QRY_PACKAGE_INFO不提供家長訂購業(yè)務(wù)二次確認(rèn)短信接口PRT_SEND_COMFIRM_SMS不提供業(yè)務(wù)開通驗證碼下發(fā)接口SEND_CAPTCHA_SMS不提供驗證碼開通業(yè)務(wù)接口PUT_CAPTCHA_ORDER不提供驗證碼開通業(yè)務(wù)接口(代理商開通類型)PUT_CAPTCHA_ORDER_SI不提供查詢家長用戶訂購業(yè)務(wù)情況接口QRY_ORDER不提供業(yè)務(wù)訂購概要變更日志接口QRY_CHG_MAIN不提供不提供不提供業(yè)務(wù)訂購明細(xì)變更日志接口QRY_CHG_DETAIL不提供查詢某個用戶所有訂購關(guān)系QRY_ORDER3不提供某個應(yīng)用的訂購情況QRY_BATCH_ORDER不提供成績模塊獲取學(xué)生成績接口QRY_STU_SCORE不提供一卡通學(xué)生普通考勤信息批量推送接口SEND_STU_KQ不提供消費信息批量推送接口SEND_BATCH_DEALRECORD不提供實時考勤數(shù)據(jù)發(fā)送接口SEND_REAL_KQ不提供一卡通推送失敗查詢接口QRY_YKT_ERROR_RESULT不提供說明:不提供,即第三方應(yīng)用無權(quán)限調(diào)用該接口;限制提供,即第三方應(yīng)用調(diào)用該接口將受到次數(shù)的限制,具體限制次數(shù)請登錄開放平臺查閱。消息交互實現(xiàn)與約定如無特別說明,和教育平臺與第三方應(yīng)用的數(shù)據(jù)交互接口采用WebService方式,Webservice接口使用SOAP協(xié)議。需要傳遞的數(shù)據(jù)采用XML作為數(shù)據(jù)表達(dá)形式,全部采用同步方式實現(xiàn)。字符集編碼用UTF-8。消息頭和消息體在xml中的表現(xiàn)形式如下:請求報文<?xmlversion="1.0"encoding="UTF-8"?><SOAP-ENV:Envelopexmlns:SOAP-ENV="/soap/envelope/" xmlns:ns1="/edu/"> <SOAP-ENV:Body> <ns1:Request> <Version>版本號</Version> <MsgSeq>消息序列號</MsgSeq> <MsgType>消息類型</MsgType> <TimeStamp>時間戳</TimeStamp> <PerformCode>平臺代碼</PerformCode> <Skey>數(shù)據(jù)有效性簽名</Skey> <Body>請求報文體</Body> </ns1:Request> </SOAP-ENV:Body></SOAP-ENV:Envelope>請求報文頭請求報文各字段解釋如下:序號父元素名稱元素名稱約束類型寬度描述取值說明1—Request1——請求報文頭1.1RequestVersion1StringV10版本信息1.01.2RequestMsgType1StringV50消息類型根據(jù)接口定義填寫1.3RequestMsgSeq1StringV30消息序列號1.4RequestTimeStamp1StringV30時間戳yyyy-MM-ddHH:mm:ssffff1.5RequestPerformCode1StringV50平臺代碼由和教育平臺統(tǒng)一分配1.6RequestSkey1StringV32數(shù)據(jù)有效性簽名數(shù)據(jù)有效性簽名,Md5(PerformCode+TimeStamp+MsgSeq+MsgType+platformkey)輸出32位全大寫字母,其中platformkey是約定的密匙(和PerformCode一起由和教育平臺分配)(注:“+”號為連接意思,不包含在被加密的字符串中)1.7RequestBody1請求報文體請求報文體請求報文體,是請求報文體的具體內(nèi)容,以XML的格式表達(dá),請求報文體樣例如下:<MSG_BODY> <Id>123456789000</Id></MSG_BODY>響應(yīng)報文<?xmlversion="1.0"encoding="utf-8"?><soapenv:Envelopexmlns:soapenv="/soap/envelope/" xmlns:ns1="/edu/"> <soapenv:Body> <ns1:Response> <Version>版本號</Version> <MsgType>消息類型</MsgType> <MsgSeq>消息序列號</MsgSeq> <TimeStamp>時間戳</TimeStamp> <Result>返回結(jié)果</Result> <Desc>結(jié)果描述</Desc> <Body>應(yīng)答報文體</Body> </ns1:Response> </soapenv:Body></soapenv:Envelope>響應(yīng)報文頭響應(yīng)報文各個字段解釋如下表序號父元素名稱元素名稱約束類型寬度描述取值說明1—Response1——響應(yīng)報文頭1.1ResponseVersion1StringV10版本信息1.01.2ResponseMsgType1StringV50消息類型根據(jù)接口定義填寫1.3ResponseMsgSeq1StringV30消息序列號1.4ResponseTimeStamp1StringV30時間戳yyyy-MM-ddHH:mm:ssffff1.5ResponseResult1StringV5返回結(jié)果200:成功400:BadRequest403:拒絕執(zhí)行請求404:NotFound408:超時413:請求實體過大480:服務(wù)暫時無法使用486:服務(wù)器忙500:服務(wù)器內(nèi)部錯誤503:服務(wù)器不可用504:無操作權(quán)限700:其他錯誤1.6ResponseDesc1StringV100返回結(jié)果描述1.7ResponseBody1響應(yīng)報文體響應(yīng)報文體應(yīng)答報文體,是應(yīng)答報文體的具體內(nèi)容,以XML的格式表達(dá),應(yīng)答報文體樣例如下:<MSG_BODY><TeacherId>12323</TeacherId><TeacherName>劉星</TeacherName><SchoolId>9765</SchoolId></MSG_BODY>Wsdl文件所有webservices均使用同一個wsdl文件。WSDL文件生成地址請向接口人獲取。平臺能力服務(wù)授權(quán)認(rèn)證用戶驗證接口業(yè)務(wù)描述第三方應(yīng)用調(diào)用此接口完成用戶登錄的有效性驗證。該接口實現(xiàn)兩個驗證方式:方式一:單點登錄驗證。用戶在和教育門戶通過點擊圖標(biāo)(uri)跳轉(zhuǎn)到第三方應(yīng)用的平臺,uri會增加token參數(shù)及對應(yīng)的用戶值,第三方應(yīng)用平臺獲取到該參數(shù)后調(diào)用此接口完成驗證,如果驗證通過會返回用戶的基本信息。如果驗證不通過會返回603錯誤,并提示token無效。方式二:引用和教育登錄組件實現(xiàn)單點認(rèn)證。第三方應(yīng)用平臺調(diào)用和教育平臺的登錄組件(http://.../oauth/login.do?appCode=123)。用戶在界面輸入和教育平臺的賬號與密碼后提交,登錄組件將進行登錄驗證檢查,檢查通過后組件會根據(jù)第三方應(yīng)用的應(yīng)用code(appCode)找到該應(yīng)用的回調(diào)地址(在開放平臺申請接入時注冊的地址),并返回token參數(shù)給第三方應(yīng)用,第三方應(yīng)用平臺獲取到該參數(shù)后調(diào)用此接口完成驗證。接口描述MsgType:CHK_OAUTH請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYToken1StringV32登錄驗證標(biāo)記登錄時由和教育平臺提供。響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYCityId1StringV20地區(qū)代碼例如:gz,zs1.2MSG_BODYUserId1Integer和教育平臺的用戶ID學(xué)生ID,老師ID或家長用戶ID1.3MSG_BODYLoginName1StringV50登錄名如果是手機號碼,則返回處理后字符串,即中間四位用*號替換1.4MSG_BODYUserName1StringV50真實姓名1.5MSG_BODYHeadImage?StringV200頭像地址1.6MSG_BODYEMail?StringV200郵箱地址1.7MSG_BODYRoleType1Integer用戶角色1老師,2學(xué)生,3家長1.8MSG_BODYSchoolId?Integer學(xué)校ID如果是家長則學(xué)校ID為空1.9MSG_BODYIcNo?StringV20IC卡號1.10MSG_BODYSex?StringV10性別1.11MSG_BODYCheckCode?StringV100驗證代碼1.12MSG_BODYBankV2.06版本新增參數(shù)V2.06版本新增參數(shù)?Integer年級編號只有用戶角色為學(xué)生、家長時此字段有效,見附件二1.13MSG_BODYsection?StringV50學(xué)段支持多個學(xué)段-1:無,1:幼兒園,2:小學(xué),3:初中,4:高中。多個用逗號’,’隔開1.14MSG_BODYAccountIdV2.06版本新增參數(shù)V2.06版本新增參數(shù)1Integer賬號編號這個是賬號編號,其性質(zhì)與用戶ID不同。例如一個家長有多個孩子,那么他的賬號編號是同一個但是用戶ID不同。用戶驗證2.0接口業(yè)務(wù)描述第三方應(yīng)用調(diào)用此接口完成用戶(包括學(xué)籍用戶和互聯(lián)網(wǎng)用戶)登錄的有效性驗證。該接口實現(xiàn)兩個驗證方式:方式一:單點登錄驗證。用戶在和教育門戶通過點擊圖標(biāo)(uri)跳轉(zhuǎn)到第三方應(yīng)用的平臺,uri會增加token參數(shù)及對應(yīng)的用戶值,第三方應(yīng)用平臺獲取到該參數(shù)后調(diào)用此接口完成驗證,如果驗證通過會返回用戶的基本信息。如果驗證不通過會返回714錯誤,并提示token無效。方式二:引用和教育登錄組件實現(xiàn)單點認(rèn)證。第三方應(yīng)用平臺調(diào)用和教育平臺的登錄組件(http://.../oauth/login.do?appCode=123)。用戶在界面輸入和教育平臺的賬號與密碼后提交,登錄組件將進行登錄驗證檢查,檢查通過后組件會根據(jù)第三方應(yīng)用的應(yīng)用code(appCode)找到該應(yīng)用的回調(diào)地址(在開放平臺申請接入時注冊的地址),并返回token參數(shù)給第三方應(yīng)用,第三方應(yīng)用平臺獲取到該參數(shù)后調(diào)用此接口完成驗證。備注:學(xué)籍用戶:所有字段有效。互聯(lián)網(wǎng)用戶:用戶ID(OpenId)、用戶角色、用戶類型等字段有效,其他無效。接口描述MsgType:CHK_OAUTH2請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYToken1StringV32登錄驗證標(biāo)記登錄時由和教育平臺提供響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYCityId?StringV20地區(qū)代碼例如:gz,zs1.2MSG_BODYUserId1Integer用戶IDUserType=0時:學(xué)生ID,老師ID或家長用戶ID;1.3MSG_BODYOpenId1String用戶IDUserType=1時,用戶唯一標(biāo)識1.4MSG_BODYUserType1Integer用戶類型0學(xué)籍用戶、1無學(xué)籍用戶(互聯(lián)網(wǎng)注冊)1.5MSG_BODYLoginName1StringV50登錄名如果是手機號碼,則返回處理后字符串,即中間四位用*號替換1.6MSG_BODYUserName?StringV50真實姓名1.7MSG_BODYHeadImage?StringV200頭像地址1.8MSG_BODYEMail?StringV200郵箱地址1.9MSG_BODYRoleType1Integer用戶角色1老師,2學(xué)生,3家長1.10MSG_BODYSchoolId?Integer學(xué)校ID如果是家長則學(xué)校ID為空1.11MSG_BODYIcNo?StringV20IC卡號1.12MSG_BODYSex?StringV10性別1.13MSG_BODYCheckCode?StringV100驗證代碼1.14MSG_BODYBank?Integer年級編號只有用戶角色為學(xué)生、家長時此字段有效,見附件二1.15MSG_BODYAccountId1Integer賬號編號這個是賬號編號,其性質(zhì)與用戶ID不同。例如一個家長有多個孩子,那么他的賬號編號是同一個但是用戶ID不同。1.16MSG_BODYsection?StringV50學(xué)段支持多個學(xué)段-1:無,1:幼兒園,2:小學(xué),3:初中,4:高中。多個用逗號’,’隔開單點登錄組件業(yè)務(wù)描述第三方應(yīng)用平臺可調(diào)用該組件,并結(jié)合“用戶驗證接口”,實現(xiàn)用戶單點登錄。組件描述組件地址:/oauth/login.do?appCode=hefte開放平臺提供了一個登錄地址,以方便用戶使用和教育平臺的賬號與密碼來登錄第三方平臺。appCode參數(shù)為第三方應(yīng)用的應(yīng)用code。合作商在創(chuàng)建應(yīng)用的自己的應(yīng)用時可以指定。如果驗證通過,開放平臺會生成一個token參數(shù),并訪問合作商創(chuàng)建應(yīng)用時填寫的應(yīng)用入口地址(例如:/?token=68de6b065869ad1bd38d3c0bd0c9b6b8)。第三方應(yīng)用程序拿到token值后,需要調(diào)用“用戶驗證接口”來判斷該token是不是開放平臺生成的token。(圖三,用戶登錄界面)無學(xué)籍用戶注冊組件(H5)業(yè)務(wù)描述無學(xué)籍用戶注冊賬號通過兩種方式來進行:方式一:通過和教育門戶進行注冊,地址:方式二:通過開放平臺提供的組件來進行注冊。第三方應(yīng)用平臺調(diào)用和教育平臺的用戶注冊組件。用戶在頁面輸入注冊需要的信息后,向用戶手機發(fā)送一條驗證碼,驗證碼驗證正確之后,會注冊一個對應(yīng)的無學(xué)籍賬戶,并通過單點登錄的地址返回token參數(shù)給第三方應(yīng)用,第三方應(yīng)用平臺獲取到該參數(shù)后調(diào)用用戶驗證2.0接口獲得用戶信息,并開展后續(xù)業(yè)務(wù)。其中參數(shù)appCode為必填,mobile為非必填。組件地址組件地址:http://.../oauth/register.do?appCode=XXX&mobile=XXX基礎(chǔ)數(shù)據(jù)獲取地市所有鎮(zhèn)區(qū)信息接口業(yè)務(wù)描述可通過此接口查詢各地市的鎮(zhèn)區(qū)基本信息,包括鎮(zhèn)區(qū)ID、鎮(zhèn)區(qū)名稱、鎮(zhèn)區(qū)代碼、排序號。接口描述MsgType:QRY_TOWN請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYTownList1鎮(zhèn)區(qū)列表1.2TownListTownEntity1鎮(zhèn)區(qū)1.2.1TownEntityCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一1.2.2TownEntityTownId1Integer鎮(zhèn)區(qū)ID1.2.3TownEntityTownName1StringV30鎮(zhèn)區(qū)名稱1.2.4TownEntityCode1StringV3鎮(zhèn)區(qū)代碼1.2.5TownEntitySequence?Integer排序號1.2.6TownEntityModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:<MSG_BODY><CityId>zs</CityId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><TownList><TownEntity><TownId>101</TownId><TownName>東區(qū)</TownName><CityId>zs</CityId><Code>002</Code><Sequence>999</Sequence></TownEntity><TownEntity><TownId>104</TownId><TownName>火炬區(qū)</TownName><CityId>zs</CityId><Code>003</Code><Sequence>999</Sequence></TownEntity></TownList></MSG_BODY>獲取鎮(zhèn)區(qū)所有學(xué)校信息接口業(yè)務(wù)描述通過鎮(zhèn)區(qū)ID獲取該鎮(zhèn)區(qū)下的所有學(xué)校信息,包括學(xué)校ID、所屬地區(qū)鎮(zhèn)區(qū)、學(xué)校名稱、學(xué)校類型。接口描述MsgType:QRY_BATCH_SCHOOL請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYTownId1Integer鎮(zhèn)區(qū)ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYSchool1Integer學(xué)校實體1.2.1SchoolSchoolID1Integer學(xué)校ID1.2.2SchoolAreaId1Integer地區(qū)ID1.2.3SchoolAreaName1StringV50地區(qū)1.2.4SchoolTownId1Integer鎮(zhèn)區(qū)ID1.2.5SchoolTownName1StringV100鎮(zhèn)區(qū)1.2.6SchoolSchoolName1StringV100學(xué)校名字1.2.7SchoolSection1Integer學(xué)校類型學(xué)段:0幼兒園1小學(xué)2初中3高中7九年一貫制8完全中學(xué)10十二年一貫制5高校6職業(yè)技術(shù)學(xué)校9特殊教育學(xué)校1.2.8SchoolCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一1.2.9SchoolModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:<MSG_BODY><TownId>101</TownId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><School><SchoolId>123</SchoolId><AreaId>1</AreaId><AreaName>中山</AreaName><TownName>東區(qū)</TownName><SchoolName>東區(qū)長江小學(xué)</SchoolName><Section>0</Section><TownId>101</TownId><CityId>zs</CityId></School><School><SchoolId>124</SchoolId><AreaId>1</AreaId><AreaName>中山</AreaName><TownName>東區(qū)</TownName><SchoolName>東區(qū)沙崗小學(xué)</SchoolName><Section>0</Section><TownId>101</TownId><CityId>zs</CityId></School></MSG_BODY>獲取學(xué)校所有班級信息接口業(yè)務(wù)描述通過學(xué)校ID獲取該校的所有班級信息,包括班級ID、學(xué)校ID、所在年級、班級類型。接口描述MsgType:QRY_BATCH_CLASS請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYSchoolId1Integer學(xué)校ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYClassList1班級列表1.1.1ClassListClassEntity1班級ClassEntityClassId1Integer班級IDClassEntitySchoolId1Integer學(xué)校IDClassEntityGradeId1Integer年級IDClassEntityGradeName1StringV50年級名稱ClassEntityBank1Integer年級編號見附件二ClassEntityClassName1StringV50班級名稱ClassEntityClassType1Integer班級類型1正規(guī)班,2興趣班ClassEntityModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:<MSG_BODY><SchoolId>123</SchoolId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><ClassList><ClassEntity><ClassId>12001</ClassId><SchoolId>123</SchoolId><GradeId>23924</GradeId><GradeName>三年級</GradeName><Bank>-3</Bank><ClassName>三(3)班</ClassName><ClassType>1</ClassType></ClassEntity><ClassEntity><ClassId>12345</ClassId><SchoolId>123</SchoolId><GradeId>23656</GradeId><GradeName>二年級</GradeName><Bank>-5</Bank><ClassName>二(1)班</ClassName><ClassType>1</ClassType><ModifyTime>2014-02-1812:00:00</ModifyTime></ClassEntity></ClassList></MSG_BODY>獲取學(xué)校所有教師信息接口業(yè)務(wù)描述通過學(xué)校ID獲取該學(xué)校的所有教師帳號信息,包括所屬地區(qū)鎮(zhèn)區(qū)、學(xué)校名稱、教師ID、登錄帳號、真實姓名、頭像地址、郵箱地址、IC卡號、性別。接口描述MsgType:QRY_SCHOOL_TEACHER請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYSchoolId1Integer學(xué)校ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYTeacherInfo?1.1.1TeacherInfoSchoolId1Integer學(xué)校ID1.1.2TeacherInfoAreaName1StringV50地區(qū)1.1.3TeacherInfoTownName1StringV100鎮(zhèn)區(qū)1.1.4TeacherInfoSchoolName1StringV100學(xué)校名字1.1.5TeacherInfoTeacherId1Integer老師ID1.1.6TeacherInfoLoginName1StringV50登錄帳號1.1.7TeacherInfoUserName1StringV50真實姓名1.1.8TeacherInfoHeadImage?StringV200頭像地址1.1.9TeacherInfoEMail?StringV200郵箱地址1.1.10TeacherInfoIcNo?StringV20IC卡號1.1.11TeacherInfoSex?StringV10性別男,女,未知1.1.12TeacherInfoRoleId?Integer角色I(xiàn)D1.1.13TeacherInfoRoleName?StringV100角色名稱1.1.14TeacherInfoModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:<MSG_BODY><SchoolId>124</SchoolId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><TeacherInfo><SchoolId>124</SchoolId><AreaName>中山</AreaName><TownName>東區(qū)</TownName><SchoolName>東區(qū)沙崗小學(xué)</SchoolName><TeacherId>198362</TeacherId><LoginName>zswangxiaoya</LoginName><UserName>王小丫</UserName><EMail>wangxiaoya@163.com</EMail><Sex>未知</Sex></TeacherInfo><TeacherInfo><SchoolId>124</SchoolId><AreaName>中山</AreaName><TownName>東區(qū)</TownName><SchoolName>東區(qū)沙崗小學(xué)</SchoolName><TeacherId>299596</TeacherId><LoginName>zswangxiaomin</LoginName><UserName>王小明</UserName><Sex>未知</Sex></TeacherInfo></MSG_BODY>獲取某班級所有學(xué)生信息接口業(yè)務(wù)描述通過班級ID獲取該班級所有對應(yīng)的學(xué)生帳號信息,包括學(xué)校ID、班級ID、班級名稱、學(xué)生ID、登錄帳號、學(xué)籍號、真實姓名、IC卡號、性別。接口描述MsgType:QRY_CLASS_STUDENT請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一1.2MSG_BODYClassId1Integer班級ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYStudentInfo11.1.1StudentInfoSchoolId1Integer學(xué)校ID1.1.2StudentInfoClassIdInteger班級ID1.1.3StudentInfoClassName1StringV50班級名稱1.1.4StudentInfoStudentIdSringV50學(xué)生ID(用戶ID)1.1.5StudentInfoLoginNameStringV50登錄帳號1.1.6StudentInfoStudentSeq1StringV12學(xué)籍號1.1.7StudentInfoUserName1StringV50真實姓名1.1.8StudentInfoHeadImage?StringV200頭像地址1.1.9StudentInfoEMail?StringV200郵箱地址1.1.10StudentInfoIcNo?StringV20IC卡號1.1.11StudentInfoSex?StringV10性別1.1.12StudentInfoModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:<MSG_BODY><CityId>zs</CityId><ClassId>103768</ClassId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><StudentInfo><ClassId>103768</ClassId><ClassName>小二(2)班</ClassName><GradeId>40247</GradeId><GradeName>二級年</GradeName><StudentId>331056</StudentId><StudentSeq>130900411044</StudentSeq><UserName>張三</UserName><Sex>男</Sex><SchoolId>50091</SchoolId></StudentInfo><StudentInfo><ClassId>103768</ClassId><ClassName>小二(2)班</ClassName><GradeId>40247</GradeId><GradeName>二級年</GradeName><StudentId>331056</StudentId><StudentSeq>130900411056</StudentSeq><UserName>李四</UserName><Sex>男</Sex><SchoolId>50091</SchoolId></StudentInfo></MSG_BODY>獲取班級與教師關(guān)系信息接口業(yè)務(wù)描述通過該接口獲取班級與教師之間的關(guān)系信息,包括該教師所教的科目、教師角色類型。該接口提供通過班級ID獲取所有老師對應(yīng)數(shù)據(jù),也可通過教師ID獲取該老師對應(yīng)的班級數(shù)據(jù)。接口描述MsgType:QRY_CLASS_TEACHER請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYClassId?Integer班級ID兩個值中必需有一個不能為空1.2MSG_BODYTeacherId?Integer老師ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYRelations?1.1.1RelationsClassTeacherRelation*ClassTeacherRelationClassId1Integer班級IDClassTeacherRelationGradeId1Integer年級IDClassTeacherRelationGradeName1StringV50年級名稱ClassTeacherRelationClassName1StringV50班級名稱ClassTeacherRelationTeacherId1Integer老師IDClassTeacherRelationLoginName1StringV50登錄帳號ClassTeacherRelationUserName1StringV50真實姓名ClassTeacherRelationHeadImage?StringV200頭像地址ClassTeacherRelationEMail?StringV200郵箱地址0ClassTeacherRelationUserType1Integer角色類型1班主任,2任課老師,3班主任兼任課老師,0不符合的數(shù)據(jù),4其他角色1ClassTeacherRelationSubjectList?科目列表1.1SubjectListSubject*科目1.1.1SubjectSubjectId1Integer科目ID1.1.2SubjectSubjectName1StringV50科目名稱示例請求消息體實例:<MSG_BODY><ClassId>605668</ClassId><TeacherId>2552341</TeacherId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><Relations><ClassTeacherRelation><ClassId>605668</ClassId><ClassName>小六(1)班</ClassName><GradeId>514341</GradeId><GradeName>小六</GradeName><TeacherId>2552341</TeacherId><LoginName>jmwujingrang</LoginName><UserName>吳敬讓</UserName><SubjectList><Subject><SubjectId>1</SubjectId><SubjectName>語文</SubjectName></Subject><Subject><SubjectId>2</SubjectId><SubjectName>數(shù)學(xué)</SubjectName></Subject><Subject><SubjectId>3</SubjectId><SubjectName>英語</SubjectName></Subject></SubjectList><UserType>3</UserType></ClassTeacherRelation><ClassTeacherRelation><ClassId>605668</ClassId><ClassName>小六(1)班</ClassName><GradeId>514341</GradeId><GradeName>小六</GradeName><TeacherId>1499173</TeacherId><LoginName>jmkpjjxx</LoginName><UserName>胡楚杰</UserName><SubjectList><Subject><SubjectId>1</SubjectId><SubjectName>語文</SubjectName></Subject><Subject><SubjectId>2</SubjectId><SubjectName>數(shù)學(xué)</SubjectName></Subject></SubjectList><UserType>2</UserType></ClassTeacherRelation></Relations></MSG_BODY>批量獲取某班學(xué)生及家長信息接口業(yè)務(wù)描述第三方應(yīng)用調(diào)用此接口查詢某個班級的所有學(xué)生與家長信息,包括學(xué)生ID、學(xué)籍號、真實姓名、對應(yīng)的家長姓名、手機號碼。此接口可以一次查詢出學(xué)生和家長的基礎(chǔ)數(shù)據(jù),解決需要多次查詢其他接口才能獲取到基礎(chǔ)數(shù)據(jù)的情況。接口描述MsgType:QRY_STUPRT_BY_CLASS請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一1.2MSG_BODYClassId?Integer班級ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYStudentList學(xué)生列表1.1.1StudentListStudentEntity學(xué)生StudentEntityStudentId1Integer學(xué)生IDStudentEntityStudentSeq1StringV12學(xué)籍號StudentEntityLoginName1StringV50登錄名StudentEntityUserName1StringV50真實姓名StudentEntityHeadImage?StringV200頭像地址StudentEntityEMail?StringV200郵箱地址StudentEntitySexStringV10性別StudentEntityIcNoStringV20IC卡號StudentEntityParentList1家長列表ParentListParentEntity1家長.1ParentEntityParentId1Integer家長ID.2ParentEntityParLoginName1StringV50家長登錄名手機號碼,返回處理后字符串,即中間四位用*號替換.3ParentEntityParUserName1StringV50家長真實姓名.4ParentEntityParHeadImage?StringV200家長頭像地址.5ParentEntityParEMail?StringV200家長郵箱地址.6ParentEntityParIcNoStringV20家長IC卡號.7ParentEntityCheckCode?String驗證代碼保留字段.8ParentEntityAccountIdV2.06版本新增參數(shù)V2.06版本新增參數(shù)?Integer家長賬號編號這個是賬號編號,其性質(zhì)與用戶ID不同。例如一個家長有多個孩子,那么他的賬號編號是同一個但是用戶ID不同。當(dāng)用戶沒有在和教育平臺生成賬號時賬號編號為空。示例請求消息體實例:<MSG_BODY><CityId>zs</CityId><ClassId>1030104</ClassId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><StudentList><StudentEntity><StudentId>3052963</StudentId><StudentSeq>120900465406</StudentSeq><LoginName>zsyeyuxuan2</LoginName><UserName>葉宇軒</UserName><ParentList><ParentEntity><ParentId>4961669</ParentId><ParLoginName>138****0136</ParLoginName><ParUserName>葉宇軒家長</ParUserName><CheckCode>f54cp5Cfh1SW/R6EALkVMpuJrr1tgEtGb7KSzaKTNBaRYMIbRjHVRQ</CheckCode></ParentEntity><ParentEntity><ParentId>4961670</ParentId><ParLoginName>137****4325</ParLoginName><ParUserName>葉宇軒家長2</ParUserName><CheckCode>8660Iai92Dioxn3SsV/oONtNy5BoWWqFCizy5ZXHm6AHjFVMgv55hw</CheckCode></ParentEntity></ParentList></StudentEntity><StudentEntity><StudentId>3052964</StudentId><StudentSeq>120900465407</StudentSeq><LoginName>zsxuruize</LoginName><UserName>徐瑞澤</UserName><ParentList><ParentEntity><ParentId>4961671</ParentId><ParLoginName>135****9946</ParLoginName><ParUserName>徐瑞澤家長</ParUserName><CheckCode>6770AHUr80YdncAxXSs/cC8vsqREQuW3ofqNSfFDn18NCdlcHhP/Hw</CheckCode></ParentEntity></ParentList></StudentEntity></StudentList></MSG_BODY>獲取某學(xué)校信息接口業(yè)務(wù)描述可通過此接口獲取指定學(xué)校的基本信息,包括所屬地區(qū)鎮(zhèn)區(qū)、學(xué)校名稱、學(xué)校類型。接口描述MsgType:QRY_SCHOOL請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYSchoolId1Integer學(xué)校ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYSchoolId1Integer學(xué)校ID1.2MSG_BODYAreaId1Integer地區(qū)ID1.3MSG_BODYAreaName1StringV50地區(qū)1.4MSG_BODYTownId1Integer鎮(zhèn)區(qū)ID1.5MSG_BODYTownName1StringV100鎮(zhèn)區(qū)1.6MSG_BODYSchoolName1StringV100學(xué)校名字1.7MSG_BODYSection1Integer學(xué)校類型學(xué)段:0幼兒園1小學(xué)2初中3高中7九年一貫制8完全中學(xué)10十二年一貫制5高校6職業(yè)技術(shù)學(xué)校9特殊教育學(xué)校1.8MSG_BODYCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一1.9MSG_BODYModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:<MSG_BODY><SchoolId>49526</SchoolId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><SchoolId>49526</SchoolId><AreaId>1</AreaId><AreaName>中山</AreaName><TownName>火炬區(qū)</TownName><SchoolName>開發(fā)區(qū)濠頭中學(xué)</SchoolName><Section>4</Section><TownId>3184</TownId><CityId>zs</CityId></MSG_BODY>獲取某班級信息接口業(yè)務(wù)描述第三方應(yīng)用調(diào)用此接口可以獲取到班級的基本信息,包括學(xué)校ID、所屬年級、班級名稱、班級類型。可以通過學(xué)校ID來查詢這個學(xué)校的所有的班級,也可以通過指定班級ID查詢某一個班級。接口描述MsgType:QRY_CLASS請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYClassId?Integer班級ID響應(yīng):和教育平臺–>第三方應(yīng)用序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYClassId1Integer班級ID1.2MSG_BODYSchoolId1Integer學(xué)校ID1.3MSG_BODYGradeId1Integer年級ID1.4MSG_BODYGradeName1StringV50年級名稱1.5MSG_BODYBank1Integer年級編號見附件二1.6MSG_BODYClassName1StringV50班級名稱1.7MSG_BODYClassType1Integer班級類型1正規(guī)班,2興趣班1.8MSG_BODYModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:<MSG_BODY><CityId>zs</CityId><ClassId>1090555</ClassId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><ClassId>1090555</ClassId><SchoolId>50079</SchoolId><GradeId>420037</GradeId><GradeName>幼兒園小班</GradeName><Bank>-5</Bank><ClassName>幼兒園小班(1)班</ClassName><ClassType>1</ClassType></MSG_BODY>獲取科目信息接口業(yè)務(wù)描述通過該接口可取得和教育平臺的基礎(chǔ)學(xué)科和學(xué)校自定義學(xué)科信息。接口描述MsgType:QRY_SUBJECT請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYSchoolId1Integer學(xué)校ID1.2MSG_BODYSubjectId1Integer科目ID響應(yīng):和教育平臺–>第三方應(yīng)用序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYSubjectList1Integer1.2SubjectListSubjectEntity1Integer1.2.1SubjectEntitySubjectId1Integer科目ID1.2.2SubjectEntitySubjectName1StringV50科目名稱1.2.3SubjectEntitySubjectType1Integer科目類型1.2.4SubjectEntityModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:響應(yīng)消息實例:獲取教師用戶信息接口業(yè)務(wù)描述第三方應(yīng)用調(diào)用此接口可以獲取到教師用戶的基本信息,包括教師ID、登錄名、真實姓名、頭像地址、郵箱地址、所屬學(xué)校、IC卡號、性別。接口描述MsgType:QRY_TEACHER_INFO請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一1.2MSG_BODYUserId1Integer和教育平臺的用戶ID老師ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYUserId1Integer和教育平臺的用戶ID老師ID1.2MSG_BODYLoginName1StringV50登錄名如果是手機號碼,則返回處理后字符串,即中間四位用*號替換1.3MSG_BODYUserName1StringV50真實姓名1.4MSG_BODYHeadImage?StringV200頭像地址1.5MSG_BODYEMail?StringV200郵箱地址1.6MSG_BODYSchoolId?Integer學(xué)校ID1.7MSG_BODYIcNo?StringIC卡號1.8MSG_BODYSex?String性別1.9MSG_BODYRoleId?Integer角色I(xiàn)D1.10MSG_BODYRoleName?StringV100角色名稱1.11MSG_BODYCheckCode?StringV100驗證代碼1.12MSG_BODYModifyTime?String最后修改時間格式:yyyy-MM-ddHH:mm:ss示例請求消息體實例:<MSG_BODY><CityId>zs</CityId><UserId>2552341</UserId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><UserId>2552341</UserId><LoginName>jmwujingrang</LoginName><UserName>吳敬讓</UserName><SchoolId>59187</SchoolId><Sex>0</Sex><CheckCode>b66fqcCpedA8R0imjrc3TUS3VcZsTg6PtqZzBd0nn530xQ3wI96g3Q</CheckCode><ModifyTime>2012-09-1916:39:22</ModifyTime></MSG_BODY>獲取家長用戶信息接口業(yè)務(wù)描述第三方應(yīng)用調(diào)用此接口可以通過家長用戶ID獲取到家長用戶的基本信息,包括登錄名、家長姓名、IC卡號、性別、對應(yīng)的學(xué)生信息。接口描述MsgType:QRY_PARENT_INFO請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一1.2MSG_BODYUserId1Integer和教育平臺的用戶ID家長用戶ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返回查詢結(jié)果。序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYUserId1和教育平臺的用戶ID家長用戶ID1.2MSG_BODYLoginName1StringV50登錄名如果是手機號碼,則返回處理后字符串,即中間四位用*號替換1.3MSG_BODYUserName1StringV50真實姓名1.4MSG_BODYHeadImage?StringV200頭像地址1.5MSG_BODYEMail?StringV200郵箱地址1.6MSG_BODYSchoolId?Integer學(xué)校ID如果是家長則學(xué)校ID為空1.7MSG_BODYIcNo?StringV20IC卡號1.8MSG_BODYSex?StringV10性別1.9MSG_BODYCheckCode?StringV100驗證代碼1.10MSG_BODYAccountIdV2.06版本新增參數(shù)V2.06版本新增參數(shù)?Integer家長賬號編號這個是賬號編號,其性質(zhì)與家長用戶ID。例如一個家長有多個孩子,那么他的賬號編號是同一個但是用戶ID不同。當(dāng)用戶沒有在和教育平臺生成賬號時賬號編號為空。1.11MSG_BODYModifyTime?StringV20最后修改時間格式:yyyy-MM-ddHH:mm:ss1.12MSG_BODYStuUserId?StringV50學(xué)生用戶ID1.13MSG_BODYStuLoginName?StringV50學(xué)生帳號1.14MSG_BODYStuUserName?StringV50學(xué)生姓名1.15MSG_BODYStuSchoolId?Integer學(xué)生所在學(xué)校ID1.16MSG_BODYStuClassId?Integer學(xué)生所在班級ID1.17MSG_BODYStuIcNo?StringV20學(xué)生IC卡號1.18MSG_BODYStuSex?StringV10學(xué)生性別示例請求消息體實例:<MSG_BODY><CityId>zs</CityId><UserId>5384448</UserId></MSG_BODY>響應(yīng)消息實例:<MSG_BODY><UserId>5384448</UserId><UserName>劉子墨家長</UserName><SchoolId>49896</SchoolId><StuUserId>3213283</StuUserId><StuLoginName>liuzimo2</StuLoginName><StuUserName>劉子墨</StuUserName><StuSchoolId>49896</StuSchoolId><StuClassId>502902</StuClassId><StuSex>男</StuSex><CheckCode>016dLzL6ON1LdDg0DN+EP2DQUXfwzc36w8ShOsaHmn71Zzhx3asyoQ</CheckCode></MSG_BODY>獲取學(xué)生用戶信息接口業(yè)務(wù)描述第三方應(yīng)用調(diào)用此接口可以獲取到學(xué)生用戶的基本信息,包括學(xué)校ID、班級ID、班級名稱、學(xué)生ID、登錄帳號、學(xué)籍號、真實姓名、IC卡號、性別、對應(yīng)的家長列表。接口描述MsgType:QRY_STUDENT_INFO請求:第三方應(yīng)用–>和教育平臺序號父元素名稱元素名稱約束類型寬度描述取值說明1.1MSG_BODYCityId1StringV10和教育平臺的地市標(biāo)識取值詳見附錄一1.2MSG_BODYUserId1Integer和教育平臺的用戶ID學(xué)生用戶ID響應(yīng):和教育平臺–>第三方應(yīng)用和教育平臺返

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論