欢迎来到麦多课文档分享! | 帮助中心 海量文档,免费浏览,给你所需,享你所想!
麦多课文档分享
全部分类
  • 标准规范>
  • 教学课件>
  • 考试资料>
  • 办公文档>
  • 学术论文>
  • 行业资料>
  • 易语言源码>
  • ImageVerifierCode 换一换
    首页 麦多课文档分享 > 资源分类 > PDF文档下载
    分享到微信 分享到微博 分享到QQ空间

    DB4401 T 223-2023 教育电子学习资源数据接口规范.pdf

    • 资源ID:1554546       资源大小:1.91MB        全文页数:35页
    • 资源格式: PDF        下载积分:5000积分
    快捷下载 游客一键下载
    账号登录下载
    微信登录下载
    二维码
    微信扫一扫登录
    下载资源需要5000积分(如需开发票,请勿充值!)
    邮箱/手机:
    温馨提示:
    如需开发票,请勿充值!快捷下载时,用户名和密码都是您填写的邮箱或者手机号,方便查询和重复下载(系统自动生成)。
    如需开发票,请勿充值!如填写123,账号就是123,密码也是123。
    支付方式: 支付宝扫码支付    微信扫码支付   
    验证码:   换一换

    加入VIP,交流精品资源
     
    账号:
    密码:
    验证码:   换一换
      忘记密码?
        
    友情提示
    2、PDF文件下载后,可能会被浏览器默认打开,此种情况可以点击浏览器菜单,保存网页到桌面,就可以正常下载了。
    3、本站不支持迅雷下载,请使用电脑自带的IE浏览器,或者360浏览器、谷歌浏览器下载即可。
    4、本站资源下载后的文档和图纸-无水印,预览文档经过压缩,下载后原文更清晰。
    5、试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓。

    DB4401 T 223-2023 教育电子学习资源数据接口规范.pdf

    1、ICS 35.240.01CCS L 67DB4401广州市地方标准DB4401/T 2232023教育电子学习资源数据接口规范Specification of data interface for educational e-learning resources2023-0 8-0 5 发布2023-0 9-0 5 实施广州市市场监督管理局发 布DB4401/T 2232023I目 次前言 III引言 V1范围12规范性引用文件13术语和定义14接口数据模型及数据分类代码14.1接口数据模型14.2数据分类代码55数据接口要求 135.1接口访问流程 135.2接口协议 135.3公共参数

    2、135.4接口调用过程 175.5对象模型 175.6接口 API 19附录 A(资料性)sha1 加密代码实现(Java)22附录 B(资料性)数据接口示例23参考文献27DB4401/T XXXXX2023IIDB4401/T 2232023III前 言本文件按照GB/T 1.12020标准化工作导则第1部分:标准化文件的结构和起草规则的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由广州市教育局提出并归口。本文件起草单位:广州市电化教育馆、广州市标准化研究院、广州市越秀区市场监督管理局。本文件主要起草人:钟毅、孙立杰、彭斌、霍迎辉、郑勇、罗杰明

    3、、肖劲峰。DB4401/T XXXXX2023IVDB4401/T 2232023V引 言教育电子资源作为教育信息化业务中独特元素,承载着各种教学业务信息数据。目前现行国家、行业或地方标准无针对所有教育资源元数据,尤其是职业教育与幼儿教育、校本资源、校外课程等内容制定的标准。由于信息化技术发展迅速,各种类型的教育电子资源数据内容不断增加,出现获取资源渠道多难查询的问题,为此需出台相关标准,为全市教育电子资源管理提供参考依据。通过制定教育电子资源数据接口标准,可以统筹教师、学生、学校、校外企业等各种教育资源,形成统一规范,促进资源的共享与流转,提高资源利用率,消除由于部分教育资源内容不统一而导致

    4、的混乱无序等问题隐患。同时,统一教育电子资源数据接口标准,形成区域共建共享的资源体系基础,可促使市级平台向上与国家级、省级平台,向下与各区区级平台互联互通。本文件通过教育电子资源描述的定义与教育电子资源数据交互标准,把各级各类教育单位的资源通过数据接口方式整合,实现新增与已有的异构资源互访。广州教育电子资源的各个供应商、学校、机构通过数据交互,实现广州市内教育资源数据的共建共享。DB4401/T 22320231教育电子学习资源数据接口规范1范围本文件规定了教育电子学习资源数据接口的数据模型、数据分类代码和数据接口要求。本文件适用于为广州市行政区域内学前教育、普通中小学和中等职业学校构建的教育

    5、电子资源数据的交互与共享。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T 4880.12005语种名称代码第1部分:2字母代码GB/T 74082005数据元和交换格式信息交换日期和时间表示法GB/T 288252012信息技术学习、教育和培训学习对象分类代码JY/T 06072017基础教育教学资源元数据信息模型中国图书馆图书分类法(第五版)3术语和定义下列术语和定义适用于本文件。3.1教育电子学习资源educational e-l

    6、earning resources在教学过程中使用的多种格式的电子文件。3.2数据接口data interface数据平台内或平台之间不同组成部分衔接通讯的约定。4接口数据模型及数据分类代码4.1接口数据模型接口数据模型依据 JY/T 06072017 建立,如表 1 所示。DB4401DB4401/T 22320232表 1接口数据模型序号数据名称数据类型数据长度(字符)备注示例1标题,title多语言字符串1000该资源的描述的名字记录2语种,language_code字符串20该资源知识内容所使用的人类语言主要种类,语种分类代码从中国图书馆图书分类法(第五版)和GB/T 4880.120

    7、05中选取“zh”“en”“fr-CA”3其他标题,alternative title多语言字符串1000正式标题之外的其他名称或替代写法“zh”“次北固山下赏析”4描述,description多语言字符串2000以文本方式对资源内容的简介“通过基础知识运用、整体理解、课内语段阅读、课外拓展演练、读后研习等环节,全面掌握理解课文的重点知识。”5关键字,keyword多语言字符串1000用以描述资源主要内容的关键词语“气密性”6版本,version多语言字符串50该资源所属学科课文版本“Demo”“公开测试版”7学习方式,learningmode多语言字符串100该资源所适用的学习行为,体现学生

    8、在自主性、探究性和合作性方面的基本特征8用户类型,audience字符串200该资源的主要使用者,最重要的优先列出“学龄前儿童”9课程标准,curricularstandard字符串1000描述该资源与国家课程标准内容框架的对应关系10教材目录,textbookcode字符串1000描述该资源与教材内容框架对应关系11专题教育资源代码,specialsubject_code字符串100在实施教育教学的过程中,专门研究或讨论的题目DB4401/T 22320233表 1接口数据模型(续)序号数据名称数据类型数据长度(字符)备注示例12来源,source字符串1000该资源引用的访问互联网地址“h

    9、ttp:/ JY/T06072017 选取21视频节点,vediopoint字符串100视频资源节点时间戳22语音节点,voicepoint字符串100语音资源节点时间戳23学段代码,interval_code字符串100该资源所属学段24年级代码,grade_level_code字符串100该资源所属年级代码25学科代码,curricular_code字符串100该资源所属学科代码DB4401DB4401/T 22320234表 1接口数据模型(续)序号数据名称数据类型数据长度(字符)备注示例26版本,version多语言字符串100该资源所属学科课文版本27册数,volume多语言字符串1

    10、00该资源所属学科课文册28单元,unit多语言字符串300该资源所属学科课文单元名称29章,chapter多语言字符串300该资源所属学科课文章名称30节,part多语言字符串300该资源所属学科课章节名称31创建时间,createdtime日期时间按 GB/T 74082005 相关要求该资源创建时间“2020-06-16”32下载总数,downloadsum字符串100该资源被下载总量33点击总数,clicksum字符串100该资源被点击总量34收藏总数,collectsum字符串100该资源被收藏总量35资源类型,codelearning_resource_type_code字符串10

    11、0该资源所属资源的类型代码36资源格式,code format_code字符串100该资源在技术上的数据类型,用于确定资源所需的运行软件。格式分类代码引 用GB/T 28825 2012中媒体格式分类代码37资源大小,size字符串30资源所需计算机存储容量,该数据表明资源的实际大小“2500”38出版社,publisher多语言字符串100该资源对应课程的出版社39其他作者,authoretc多语言字符串300该资源的其他作者40摘要,abstract多语言字符串2000该资源的简要描述41二维码描述,2D字符串300该资源所在访问链接二维码描述DB4401/T 22320235表 1接口数

    12、据模型(续)序号数据名称数据类型数据长度(字符)备注示例42存储地址,address多语言字符串300该资源存储的计算机网络访问地址“http:/ code字符串100该资源属于的分类描述44关联类型代码,relationship_code字符串8描述该资源与关联资源之间的关系45关联描述,relationship_description字符串300关联资源的描述4.2数据分类代码4.2.1语种分类代码语种分类代码从中国图书馆图书分类法(第五版)和GB/T 4880.12005选取,如表2所示。表 2语种分类代码代码语言名称语种代码H1汉语zhH212蒙古语mnH214藏语boH215维吾尔语

    13、ugH216苗语H217彝语H218壮语zaH219朝鲜语koH236哈萨克语(撒里维吾尔语)kkH31英语enH32法语frH33德语deH34西班牙语esH35俄语ruH36日语jaH37阿拉伯语arH9其他qt4.2.2学习方式分类代码DB4401DB4401/T 22320236学习方式分类代码如表3所示。表 3学习方式分类代码代码类型备注L01讲授L02探究L03自学L04合作L09其他4.2.3用户类型分类代码用户类型分类代码如表4所示。表 4用户类型分类代码代码类型备注A01学生A02教师A03教育管理员A04家长A05未入学青少年A09其他用户4.2.4专题教育分类代码专题教育

    14、资源分类代码按照中国图书馆图书分类法(第五版)类目简表和JY/T 06072017,结合基础教育资源实际编制而成,如表5所示。表 5专题教育分类代码代码类型备注SS01社会主义核心价值观教育SS02法制教育SS03行为养成教育SS04安全教育SS05心理健康教育SS06国防教育SS07体育与健康教育SS08民族团结教育SS09艺术教育SS10科普教育DB4401/T 22320237表 5专题教育分类代码(续)代码类型备注SS11家庭教育SS12学校管理SS13劳动教育SS14地方教育SS15德育教育SS99其他教育4.2.5年级分类代码年级分类代码按照GB/T 288252012中适用对象分

    15、类代码,如表6所示。表 6年级分类代码代码名称备注ON正规教育ON01学前ON01010002 岁ON01020036 岁ON02小学ON020100小学一年级ON020200小学二年级ON020300小学三年级ON020400小学四年级ON020500小学五年级ON020600小学六年级ON03初中ON030100初中一年级(七年级)ON030200初中二年级(八年级)ON030300初中三年级(九年级)ON04高中ON040100高中一年级ON040200高中二年级ON040300高中三年级ON05中等职业教育ON05100中等职业教育一年级ON05200中等职业教育二年级ON05300中

    16、等职业教育三年级ON09其他年级DB44018DB4401/T 2232023 4.2.6 学科分类代码学科分类代码按照GB/T 288252012中学科分类代码,如表7所示。表 7学科分类代码代码名称备注SB基础学科SB01语言与文字SB0101语文SB0102英语SB0103俄语SB0104日语SB0105德语SB0106法语SB0107其他外语SB0108中国少数民族语文SB0201数学SB03人文与社会科学SB0301政治SB0302思想品德SB0303品德与生活SB0304品德与社会SB0305社会SB0306历史与社会SB0307历史SB0308地理SB04自然科学SB0401物理

    17、SB0402化学SB0403生物SB0404科学SB05技术SB0501劳动与技术教育SB0502信息技术SB0503职业教育SB0504通用技术DB4401/T 22320239表 7学科分类代码(续)代码名称备注SB0601艺术SB0602音乐SB0603美术SB0701体育SB0702体育与健康SB08综合实践活动SB0801综合实践活动SB0802研究性学习SB0803社区服务与社会实践SB09跨区域的学习活动SB10人工智能SB11劳动实践SB99其他课程4.2.7资源类型分类代码资源类型分类代码如表8所示。表 8资源类型分类代码代码资源类型子类型RT01教学素材RT02网络课程RT

    18、0201微课RT0202慕课RT0203网校课程RT03虚拟仿真系统RT04教育游戏RT05教学案例RT0501教学设计RT0502课堂实录RT0503教学课件RT0504导学RT0599其他RT06数字图书RT07数字教材RT08教学工具DB4401DB4401/T 223202310表 8资源类型分类代码(续)代码资源类型子类型RT09学习网站RT10习题RT1001练习RT1002章节测试RT1003期中期末考试RT1004中高考RT11课标解读RT12教材教法分析RT13实验RT99其他4.2.8格式分类代码格式分类代码按照GB/T 288252012中媒体格式分类代码,如表9所示。表

    19、 9格式分类代码代码名称备注F0文本格式F001TXT(Text File)F002RTF(Rich Text Format)F003DOCF004ODF(Open Document Format)F005UOF(Unified Office Document Format)F006PDF(Portable Document Format)F007UMD(Universal Mobile Document)F008HTML(Hyper Text Markup Language)F009XML(Extensible Markup Language)F010XPS(XML Paper Specif

    20、ication)F011PPT(PowerPoint)F012WPSF013EIOF015CLLF016PostscriptF017WordPerfectF099其他文本格式F1音频格式F101WAV(Wave)DB4401/T 223202311表 9格式分类代码(续)代码名称备注F102MP3(MPEG Audio Layer 3)F103RA(RealAudio)F104MIDI(Musical Instrument Digital Interface)F105WMA(Windows Media Audio)F106WAMF107OGG(Ogg Vorbis)F108AIFF(Audio

    21、 Interchange File Format)F109FLAC(Free Lossless Audio Code)F110SND(Sound)FI11VOC(Voice)F112MOD(Module)F113S3M(Scream tracker Modules)F114XM(Xpress Music)F115MTMF116FARF117KARF118CD(Compact Disc)F119VQF(transform-domain weighted Interleave Vector Quantization)F120ASF(Advanced Streaming Format)F121RM(

    22、Real Media)F122APEF123AVSF124MP4(MPEG-4 Part14)F199其他音频格式F2视频格式F201MPEG(Moving Pictures Experts Group)F202AVI(Audio Video Interleaved)F203RV(Real Video)F204RM(Real Media)F205RMVB(Real Media Variable Bitrate)F206WMV(Windows Media Video)F207ASF(Advanced Systems Format)F208MOVF209DIVF210DIVXF211FLV(Fla

    23、sh Video)F212DVD(Digital Versatile Disc)F213VCD(Video Compact Disc)DB4401DB4401/T 223202312表 9格式分类代码(续)代码名称备注F2143GPF215DAT(Data)F216RA(Real Audio)F217RAM(Random Access Memory)F299其他视频格式F3图形/图像F301JPEG(Joint Photographic Experts Group)F302GIF(Graphics Interchange Format)F303BMPF304TIFF(Tagged Image

    24、File Format)F305PNG(Portable Network Graphic Format)F306WMFF307PSDF308PCDF309PCXF310EPS(Encapsulated Post Script)F311CGM(Computer Graphics Metafile)F312EXIF(Exchangeable Image File)F313TGA(Tagged Graphics)F314FPXF315SVG(Scalable Vector Graphics)F316CDRF317DXF(Drawing Exchange Format)F318EPG(Electron

    25、ic Program Guide)F399其他图形/图像格式F4动画F401SWF(Shock Wave Flash)F402GIF(Graphics Interchange Format)F403MKVF499其他动画格式F9其他格式4.2.9关联类型分类代码关联类型分类代码如表10所示。DB4401/T 223202313表 10关联类型分类代码代码类型内容示例RS01部分/全部关联一种资源是另一种资源的物理或逻辑的一部分Is Part Of 组成部分Has Part 部分为RS02版本关联一种资源是一个历史的叙述或同一创建者的另一资源的版本Is Version Of 版本继承Has Ve

    26、rsion 版本关联RS03格式转换关联通过复制或重新格式技术,使得一种资源成为另外一种资源,它不是一种解释而是一种再现Is Format Of 格式转换于Has Format 格式转换为RS04参照关联某一资源的作者认可、引用、争论或提及另一种资源Is Referenced By 被参考References 参考RS05创造性关联一种资源是另一种资源的表演、制作、派生、翻译、改编或注释Is Replaced By 被替代Replaces 替代RS06附属关联一种资源需要另一种资源产生效用,并表达或反映内容Is Required By 被需求Requires 需求Conformance to

    27、遵循5数据接口要求5.1接口访问流程所有接口统一按照HTTP POST方式传递JSON格式数据,发起方定义为客户端,提供服务的为服务端。每一次数据请求为独立请求,前后两次请求之间没有关联。5.2接口协议5.2.1接口按照 REST 风格设计,通过 HTTP 协议的 GET 方法或 POST 方法提交请求。5.2.2使用 GET 方法,请求参数通过 URL 查询参数(QueryParam)提供。5.2.3使用 POST 方法,请求公共参数通过 URL 查询参数(QueryParam)提供,接口专用参数通过请求正文(Body)、按照 JSON 格式封装提供。5.3公共参数5.3.1接口的请求和返回

    28、均包含规定的公共参数,如无特殊说明,所有接口方法都应包含以下请求公共参数以及返回公共参数。5.3.2请求公共参数如表 11 所示。表 11请求公共参数参数名必选数据类型长度备注access_token是String500访问令牌,成功调用 login 接口后返回sign否String500请求参数签名值(预留)sign_method否String500签名方法(预留)DB4401DB4401/T 223202314表 11请求公共参数(续)参数名必选数据类型长度备注timestamp否Date100应用程序发出请求的客户端时间,大平台在接收到请求后,与当前服务端时间比较,如果在误差范围大于 1

    29、0 min,将请求视为无效request_id否String100应用程序发出请求的唯一标识号,大平台如果在误差时间内接收到多个 request_id 相同的请求,除最早收到的一个请求外,其它请求将视为重放攻击而被忽略5.3.3返回公共参数如表 12 所示。表 12返回公共参数参数名必选数据类型长度备注ack_code是String10接口调用是否成功:SUCCESS:成功FAILURE:失败errors否List500错误信息sign否String500请求参数签名值(预留)sign_method否String500签名方法(预留)timestamp否Date100接口响应的服务端时间cor

    30、relation_id否String100对应的请求 request_id,如果请求提供了 request_id 参数,在响应时会原样返回response_id否String100接口返回的唯一标识号5.3.4错误信息结构如表 13 所示,错误代码说明如表 14 所示。表 13错误信息结构属性必选数据类型长度备注code是String10错误代码message是String4000错误信息描述inner_code否String50内部代码DB4401/T 223202315表 14错误代码说明错误代码错误说明原因分析处理方式11001缺少 access_token 参数检 查 程 序 是 否

    31、正 确 提 供 了access_token 参数所有接口方法(除 login 外)应提供有效的access_token11002缺少 app_key 参数检 查 程 序 是 否 正 确 提 供 了app_key 参数错误需检查接口通讯情况11003缺少 sign 参数提供了 sign_method 参数,但没有提供 sign 参数建议去掉 sign_method 参数采用不签名方式,或者提供 sign 参数11004缺少 sign_method 参数提供了 sign 参数,但没有提供 sign_method 参数建议去掉 sign 参数采用不签名方式,或者提供 sign_method 参数11

    32、005缺少 timestamp 参数提供了 request_id 参数但没有提供 timestamp 参数建 议 去 掉 request_id 参 数 或 者 提 供timestamp 参数1110011199缺少第 xx 个应用参数参考接口说明,按规定提供必须的参数例如 10101 表示缺少了该方法中第 1 个输出参数(公共输入参数不计算在内)12001access_token 无效产生此错误的原因是会话尚未得到授权或者已经超时或者已被注销建议重新调用 login 方法创建一个新的授权会话12002app_key 无效表示当前程序不是合法的应用程序建议申请获得一个有效的 app_key120

    33、03签名校验失败检查签名方法是否正确,并测试在发送请求前自行进行签名验证如果检查无误仍然有此错误,有可能请求在发送过程中被篡改12004不支持的签名方法参数配置错误改用接口支持的签名方法12005请求时间超过误差范围互联双方互联通信超时问题a)运行应用程序的客户端时间与接口服务端时间相差超过 10min,建议调整客户端系统时间;b)运行应用程序的客户端与接口服务端之间的网络问题导致严重延时,如果问题持续出现建议检查网格环境,如果偶然出现建议在程序中捕获此错误并重新调用。12006收到重复的请求参数配置错误a)因为程序错误导致在多次调用中产生了相同的 request_id;b)由于网络原因请求被

    34、偶然重发,建议排查网络问题或直接略忽;c)请求被记录并重放,建议排查网络安全问题。1210012199第 xx 个应用参数不合法如出现错误代码,例如类型不匹配请按照接口说明传入正确的参数值13001第三方应用程序未获得授权调用指定方法表示所提供的 app_key 是有效的,但未获得授权调用指定的接口方法如确实需要调用此方法,请向平台管理员申请授权DB4401DB4401/T 223202316表 14错误代码说明(续)错误代码错误说明原因分析处理方式13002会话未获得授权调用指定方法当前会话上下文无权限执行相应的操作例如以部分管理员身份创建的会话中,无权新建一个部门,建议检查是否使用了正确的

    35、用户身份创建会话13003所操作的对象超出当前会话的可管理范围参数配置错误例如以 A 部门管理员身份创建的会话中,执行对 B 部门下的事项操作,将返回此错误,建议检查是否使用了正确的用户身份创建会话14101调用 getXXX 方法时找不到相应对象参数配置错误可能用来判断是否存在此对象,建议调用getXXX 方法后,对返回结果进行检查,避免对空对象进行操作1411014199调用 getXXX 方法时遇到的其它错误参数配置错误参照具体接口方法的说明1421014299调用 listXXX 方法时遇到的错误参数配置错误参照具体接口方法的说明14301创建对象时主键或具有唯一性的属性重复参数配置错

    36、误检查待创建对象的主键(对象代码)或具有唯一性的属性是否符合规范14302创建对象时不允许空属性没有赋值参数配置错误检查待创建对象中不允许空的属性14303创建对象时部分属性不符合规范参数配置错误例如格式不正确,超出值域等1431014399创建对象时遇到的其它错误参数配置错误参照具体接口方法的说明14401更新对象时主键或具有唯一性的属性重复参数配置错误检查待更新对象的主键(对象代码)或具有唯一性的属性是否符合规范14402更新对象时不允许空属性没有赋值参数配置错误检查待更新对象中不允许空的属性14403更新对象时部分属性不符合规范参数配置错误例如格式不正确,超出值域等1441014499更

    37、新对象时遇到的其它错误参数配置错误参照具体接口方法的说明14501要删除的对象不存在参数配置错误建议在删除对象之前先调用 get 或 list 接口,确认对象存在14502子对象不为空,无法删除主对象参数配置错误除接口有特殊说明外,在删除对象前应先删除所有子对象14503待删除的对象存在引用,不能删除在删除对象时,应先移除所有对该对象的引用关系例如在删除一个服务窗口前,应保证所有引用该窗口的事项中移除相应的引用关系1451014599在删除对象时遇到的其它错误参数配置错误参照具体接口方法的说明DB4401/T 223202317表 14错误代码说明(续)错误代码错误说明原因分析处理方式1900

    38、019999服务端或客户端异常,表示接口服务端或客户端程序出现不可预测的内部错误,如数据库连接问题等,暂时无法正常返回结果。偶然出现此类错误建议应用程序间隔一段时间后再自动尝试重新调用,如果持续较长时间出现此类错误,应用程序应进入服务故障处理状态,建议程序处理逻辑如下:首先停止继续调用接口,避免影响服务端的抢修工作;通过系统提示等友好方式通知受影响的用户,减少用户损失;通过短信等方式及时通过系统管理员,请系统管理员联系平台管理员尽快定位和修改故障;等待恢复后的通知,再协助进行后续的处理。5.3.5Sign 生成规则按照一定顺序规则拼接 ppKey、timestamp、randomNum、app

    39、Secre 后,再使用 sha1 加密算法,生成最后签名。额外参数如表 15 所示。表 15额外参数属性必选数据类型长度备注appSecret是string500APP 应用密钥,由网关方提供(自行保存,不可泄露)5.3.6字符串顺序规则字符串顺序规则:appSecret+randomNum+appKey+timestamp+appSecret。5.3.7sha1 加密代码实现(Java)sha1加密代码实现(Java)见附录A。5.4接口调用过程5.4.1调用 login 创建安全会话获取 access_token调用安全会话接口的login方法,以部门管理员账户创建会话获取访问令牌acce

    40、ss_token,请求示例见附录B中B.1.1。5.4.2使用 access_token 调用接口 API把access_token作为请求的公共参数来调用接口API,示例见附录B中B.1.2。5.4.3调用 logout 注销会话调用安全会话接口的logout方法,设置access_token为无效,示例见附录B中B.1.3。5.5对象模型DB440118DB4401/T 22320235.5.1 UserInfo(用户信息类)如表 16 所示。表 16UserInfo(用户信息类)属性必选长度类型备注account是100String账户名称,标识属性name是100String用户姓名i

    41、dentity_num否20String身份证件号码division是256String行政区划名称,只读属性division_code是20String行政区划代码,只读属性service_org是256ServiceOrg所属机构,只读属性extend_props否4000String扩展属性creator否100String创建者creation_time是100Date创建时间last_modificator否100String最后修改者last_modification_time是100Date最后修改时间5.5.2ResourceInfo(资源信息类)如表 17 所示。表 17Re

    42、sourceInfo(资源信息类)属性必选长度类型备注title是1000变长类型标题language_code是20变长类型语种alternative title否1000变长类型其他标题description否2000变长类型描述keyword否1000变长类型关键字version是50变长类型版本learning_mode否100变长类型学习方式audience是200变长类型用户类型curricular_tandard是1000变长类型课程标准textbook_code否1000变长类型教材目录special_subject否100变长类型专题教育资源source否1000变长类型来源

    43、author是100变长类型作者instructor否100变长类型主讲人authorc是100变长类型作者所在单位authorc_code是100变长类型作者所在单位代码author_area_code是100变长类型作者所在区域或县代码authorp_code是100变长类型作者所在省份代码authorcity_code是100变长类型作者所在城市代码DB4401/T 223202319表 17ResourceInfo(资源信息类)(续)属性必选长度类型备注knowledge_code否300变长类型课程内容分类代码vediopoint否100时间类型视频节点voicepoint否100时

    44、间类型语音节点interval_code是100变长类型学段代码grade_level_code是100变长类型年级代码curricular_code是100变长类型学科代码version是100变长类型版本volume是100变长类型册数unit是300变长类型单元chapter是300变长类型章part是100变长类型节createdtime是100时间类型创建时间downloadsum否100整数值型下载总数clicksum否100整数值型点击总数collectsum否100整数值型收藏总数learning_resource_type_Code是100变长类型资源类型format_Cod

    45、e是100变长类型资源格式size是30数值型资源大小publisher否100变长类型出版社authoretc否300变长类型其他作者abstract是2000变长类型摘要2D否100变长类型二维码描述address否300变长类型存储地址relationship_code否8变长类型关联类型代码Relationship_de否300变长类型关联类型描述5.6接口 API5.6.1安全会话登录接口 security/login.do5.6.1.1方法名称:login。5.6.1.2方法说明:通过用户名和密码进行身份验证,验证成功后创建一个会话。所有对数据和附件的管理操作都应在有效的会话内进行

    46、。5.6.1.3请求方法:POST。5.6.1.4URL 地址:http:/API_ROOT/security/login.do。5.6.1.5访问权限:所有通过授权的第三方程序。5.6.1.6请求参数:请求参数如表 18 所示。DB4401DB4401/T 223202320表 18请求参数参数名必选数据类型长度备注app_key是String500分配给应用程序的 app_keyapp_secret是String500分配给应用程序的 app_secretaccount是String500用户账户名称password是String500用户账户密码org_code否String500以指定

    47、的部门管理员身份登录5.6.1.7返回结果如表 19 所示。表 19返回结果参数名必选数据类型长度备注access_token是String500登录成功则返回安全会话访问令牌expires_in是Integer500访问令牌超时时间(以秒为单位),缺省 24hsuccess否String500登录标识msg否String500登录成功信息attributes是Map500返回的数据5.6.1.8请求示例见附录B中B.2.1。5.6.1.9返回示例见附录B中B.2.2。5.6.2安全会话注销接口 security/logout.do5.6.2.1方法名称:logout。5.6.2.2方法说明:

    48、注销当前会话。5.6.2.3请求方法:POST。5.6.2.4URL 地址:http:/API_ROOT/security/logout.do。5.6.2.5访问权限:所有已登录用户。5.6.2.6请求参数:无。5.6.2.7返回结果:无。5.6.2.8请求示例见附录 B 中 B.2.3。5.6.2.9返回示例见附录 B 中 B.2.4。5.6.3安全会话获取接口 security/get_current_user.do5.6.3.1方法名称:get_current_user。5.6.3.2方法说明:获取当前已登录用户的信息。5.6.3.3请求方法:GET。5.6.3.4URL地址:http:

    49、/API_ROOT/security/get_current_user。5.6.3.5访问权限:所有已登录用户。5.6.3.6请求参数:无。5.6.3.7返回结果如表 20 所示。DB4401/T 223202321表 20返回结果参数名必选数据类型长度备注attributes是TSUser500用户信息success否String500登录标识msg否String500登录成功信息5.6.3.8请求示例见附录B中B.2.5。5.6.3.9返回示例见附录B中B.2.6。5.6.4信息资源接口 data_subject/list.do5.6.4.1方法名称:list。5.6.4.2方法说明:根据

    50、设置条件(支持标题、作者、用户类型等)查询数据主题信息。如:查询标题包含“三角形”资源。5.6.4.3请求方法:POST。5.6.4.4URL 地址:http:/API_ROOT/data_subject/list。5.6.4.5访问权限:所有已登录用户。5.6.4.6请求参数如表 21 所示。表 21请求参数参数名必选数据类型长度备注title否String1000标题author否String100作者audience否String200用户类型5.6.4.7返回结果如表 22 所示。表 22返回结果参数名必选数据类型长度备注total_count否Integer100记录数data否Li


    注意事项

    本文(DB4401 T 223-2023 教育电子学习资源数据接口规范.pdf)为本站会员(roleaisle130)主动上传,麦多课文档分享仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对上载内容本身不做任何修改或编辑。 若此文所含内容侵犯了您的版权或隐私,请立即通知麦多课文档分享(点击联系客服),我们立即给予删除!




    关于我们 - 网站声明 - 网站地图 - 资源地图 - 友情链接 - 网站客服 - 联系我们

    copyright@ 2008-2019 麦多课文库(www.mydoc123.com)网站版权所有
    备案/许可证编号:苏ICP备17064731号-1 

    收起
    展开