GB∕T 38863-2020
基本信息
标准号:
GB∕T 38863-2020
中文名称:干部网络培训 平台数据接口技术要求
标准类别:国家标准(GB)
标准状态:现行
出版语种:简体中文
下载格式:.rar .pdf
下载大小:1800KB
相关标签:
干部
网络
培训
平台
数据
接口技术
标准分类号
关联标准
出版信息
相关单位信息
标准简介
GB∕T 38863-2020 干部网络培训 平台数据接口技术要求
GB∕T38863-2020
标准压缩包解压密码:www.bzxz.net
标准内容
ICS35.240.99
中华人民共和国国家标准
GB/T38863—2020
干部网络培训
平台数据接口技术要求
Online training for leadershipTechnical requirements for platform data interface2020-07-21发布
国家市场监督管理总局
国家标准化管理委员会
2021-02-01实施
规范性引用文件
术语和定义
缩略语
数据类型
基本数据类型
数据格式
自定义数据类型
数据参数
请求报文
响应报文
平台基本数据
系统事件类别
数据类别
接口服务
接口管理服务
数据推送同步接口服务
数据查询接口服务
附录A(资料性附录)
附录B(规范性附录)
附录C(规范性附录)
接口样例
平台数据接口清单
异常状态码:
GB/T38863—2020
本标准按照GB/T1.1-2009给出的规则起草GB/T38863—2020
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准由中共中央组织部提出并归口。本标准起草单位:华中师范大学、华东师范大学、北京邮电大学、中国电信集团有限公司、中国电子技术标准化研究院。
本标准主要起草人:吴砥、吴晨、钱冬明、饶景阳、李青、李班东、李欢冬、马兆钦、余云涛、史戈m
1范围
干部网络培训
平台数据接口技术要求
本标准规定了干部网络培训机构平台之间的接口服务及接口数据参数。本标准适用于干部网络培训机构平台之间的数据传输和交换,规范性引用文件
GB/T38863-—2020
下列文件对于本文件的应用是必不可少的品凡是注日期的引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T3304—1991
GB/T47621984
GB/T7408—2005
GB/T12407—2008
中国各民族名称的罗马字母拼写法和代码政治面貌代码
数据元和交换格式
日期和时间表示法
信息交换
职务级别代码
GB/T13000—2010
GB32100—2015
信息技术通用多八位编码字符集(UCS)法人和其他组织统一社会信用代码编码规则GB/T38856—2020
GB/T38858—2020
术语和定义
业务管理通用要求
干部网络培训
干部网络培训
平台数据要求
GB/T38856—2020、GB/T38858—2020界定的术语和定义适用于本文件。缩略语
下列缩略语适用于本文件。
AR:增强现实(AugmentedReality)ID:标识符(Identifier)
MR:混合现实(MixedReality)PV:页面浏览量(PageView)
TBTP:专题班(Theme-basedTrainingProject)URL:统一资源定位符(UniformResourceLocator)USCID:统一社会信用代码(UnifiedSocialCreditIdentifier)VR:虚拟现实(VirtualReality)5
数据类型
基本数据类型
本标准中使用的数据类型和可取值见表1。GB/T38863—2020
字符型(string)
数值型(numeric)
日期型(date)
集合(set)
5.2数据格式
表1数据类型的取值
以字符表达的数据元值的类型,可用于表达字母、数字、汉字和其他字符形式以任意实数表达的数据元值的类型以日期和时间表达的数据元值的类型,符合GB/T7408—2005,以YYYYMMDDhhmm的形式表达
用于存放其他数据的容器,集合中可包含属性和其他集合指从业务的角度规定的数据元值的格式需求,包括所允许的最大或/和最小字符长度、数据元值的表示格式等。数据格式中使用的字符含义如下:a)字母\a\表示字符;
字母“n”表示数值;
字母\a\或\n\之后的自然数表示定长个字符(字符集默认为GB/T13000一2010),或数值的十c
进制最大位数;
d)字符串“..ul\表示长度不确定;逗号\,”隔开的两个自然数“p,q”表示数值最大p个十进制位数,小数点后q位;e)
双点号“..”表示从最小长度到最大长度,前面附加最小长度,后面附加最大长度;字符串“YYYYMMDDhhmm”中的“YYYY\表示年份,“MM”表示月份,“DD\表示日期,“hh”g
表示小时,“mm”表示分钟,可以视实际情况组合使用。5.3值域
值域是根据相应属性中规定的数据类型、长度而决定的数据元的允许值的集合。该集合可通过以下方式给出:
通过参考和引用相关标准;
通过文字描述给出值域的限制
通过一一列举的方式给出所有可能的取值以及每一个值对应的实例或含义;通过规则间接给出。
5.4自定义数据类型
用户可根据需要自行扩展和定义数据类型。6概述
干部网络培训机构平台之间通过接口服务进行数据传输。接口服务分为三大类:接口管理服务、数据推送同步接口服务和数据查询接口服务,如图1所示。2
接管理服务
数期推送同步接口服务
下行运行统计数据接口
学员信点数据同步控口
红织机构激期尚工接口
课程数据间步接口
专题所数据同步按口
教据查询接|服务
学员信总查询接口
课程信息查动接口
课程学习结果记录查询按口
专题斑倍总杏询接口
专题班学可统果记录询接口
图1于部网络培训机构平台数据接口GB/T38863—2020
于部网络培训机构平台是数据服务交互过程的参与实体,所提供的服务包括管理服务和学习服务,服务请求的发起者为“服务发起方”,服务请求的提供者为“服务提供方”。于部网络培训机构平台之间的数据服务主要包括:
接口管理服务:处理服务发起方和服务提供方之间的应用请求;数据推送同步接口服务:处理参与实体间的数据同步请求;数据查询接口服务:处理服务发起方的查询请求,并由服务提供方返回结果。iiKae
报文样例参见附录A。
平台数据接口服务清单见附录B。系统异常状态码见附录C。
7数据参数
请求报文
请求报文的数据参数见表2,请求报文样例参见A.1。表2请求报文的数据参数
数据块
(数据头)
(数据体)
中文名称
平台编号
平台私钥
自定义扩展信息
推送数据类别
数据体哈希值
数据偏移值
数据长度
数据体内容
英文名称
platformID
platformKey
extension
hashcode
offset
length
content
干部网络培训平台的唯一标识
干部网络培训平台所拥有的私钥数据头的可扩展的自定义信息bzxz.net
接口推送的数据内容分类类别
数据流的哈希值
读取数据时的偏移值
读取数据体内容的长度
报文中所包含的业务数据
参见7.5
用于请求报文数据一致性校验
数据体全部采用数组形式
GB/T38863—2020
响应报文
响应报文以加密数据的形式传输,数据参数见表3,响应报文样例参见A.2。响应报文的数据参数
中文名称
响应结果
出错信息
哈希值
数组数量
返回值
返回值是否是数组
加密数据
扩展数据
平台基本数据
英文名称
response
errorMessage
hashcode
hasData
isArray
encryptData
extension
请求是否成功响应的状态标识
响应不成功时反馈的消息字符审加密数据的校验码
加密数据如果是数组时的数组数量加密数据是否有返回值
加密数据的数据结构是否是数组数据加密后的内容
可扩展的自定义信息
接口传输所涉及的平台基本数据内容见表4。kAca=
表4平台基本数据表
中文名称
平台标识符
平台名称
组织机构标识符
平台地址
管理员编号
英文名称
platformID
domainName
platformName
organizationID
platformURL
managerID
status
干部网络培训平台的唯
标识符
用于在数据传输时标识计
算机的电子方位
干部网络培训平台的名称
机构具有的唯一标识符
服务平台接口地址
平台管理员的唯一标识符
平台状态
注:“约束”栏内M表示“必备”数据元素7.4
系统事件类别
系统事件类别见表5
数据类型
管理员编码(平台生
成的唯一用户编码)
状态标识
dataOfUserCreated
dataOfUserModified
trainingInfoCreated
trainingInfoUpdated
枚举值
可根据需要自行扩展和定义事件类别。7.5
数据类别
系统事件类别
学员信息新建
学员信息变更
培训信息新建
培训信息变更
数据类别是接口报文数据体中推送数据内容的类别,见表6表6
枚举值
loginStat
visitStat
PVstat
registerStat
courseStat
creditHourStat
TBTPstat
TBTPereditHourStat
TBTPregisterStat
TBTPgraduateStat
userlnfo
userAccountInfo
organizationInfo
courselnfo
courseLearningRecord
TBTPinfo
TBTPcourselnfo
TBTPcourseLearningRecord
TBTPcertificateInfo
数据类别
登录人次统计数据
页面浏览量统计数据
首页访问量统计数据
激活学员统计数据
课程统计数据
学时统计数据
专题班统计数据
专题班学时统计数据
专题班报名人数统计数据
专题班结业人数统计数据
学员基本信息数据
学员账号信息数据
组织机构数据
课程信息数据
课程学习结果记录
专题班信息数据
专题班课程数据
专题班课程学员学习记录
专题班学习结果记录
GB/T38863—2020
GB/T38863—2020
8接口服务
接口管理服务
8.1.1注册服务请求
注册服务请求接口的基本信息包括:一接口说明:服务发起方向服务提供方请求事件通知的回调地址,用于动态注册,支持批量操作;实时性要求:即时同步;
接口参数:注册服务请求接口参数见表7;接口请求:注册服务请求的接口请求见表8,请求样例参见A.3;接口响应:注册服务请求的接口响应见表9,响应样例参见A.4。表7注册服务请求接口参数表
接口地址
body.type
中文名称
英文名称
系统事件类别
回调服务器的地址
注:“约束”栏内M表示\必备”数据元素表9
中文名称
响应结果
扩展服务
英文名称
response
message
extensionService
https:///HOST)/notify/registerPOST
注册服务请求接口请求表
值域数据类型
事件类别,何种事件触发时回调枚举值,参见表5
注册服务请求接口响应表
响应是否成功的结果
可扩展的自定义服务
1:成功
2:失败
注:“约束”栏内M表示“必备”数据元素,0表示“可选”数据元素。8.1.2取消注册请求
取消注册请求接口的基本信息包括:6
数据类型
响应是否成功
响应如果不成功,返回失败信息,异常状态码见表C.1
GB/T38863—2020
接口说明:服务发起方向服务提供方请求取消事件通知服务的回调地址,用于取消注册,支持批量操作;
实时性要求:即时同步;
接口参数:取消注册请求接口参数见表10;接口请求:取消注册请求的接口请求见表11,请求样例参见A.5;接口响应:取消注册请求的接口响应见表3。表10
取消注册请求接口参数表
接口地址
body.type
中文名称
英文名称
系统事件类别
https://(HOST)/notify/unregisterPOST
取消注册请求接口请求表
数据类型
注:“约束”栏内0表示“可选”数据元素。iikat
数据推送同步接口服务
平台运行统计数据接口
登录人次统计数据接口
登录人次统计数据接口的基本信息包括:说
需要取消的事件类别.参见表5
接口说明:服务提供方向服务发起方推送本平台学员登录统计数据:实时性要求:无;
接口参数:登录人次统计数据接口参数见表12:接口请求:登录人次统计数据的接口请求见表13,请求样例参见A.6;接口响应:登录人次统计数据的接口响应见表3,响应样例参见A.7。表12登录人次统计数据接口参数表参数
接口地址
body.type
https:///HOST)/data/push
loginStat
GB/T38863—2020
中文名称
培训机构标
当日前累计
登录人次
当日登录总
登录总人次
当日前累计
移动终端登
录人次
当日移动终
端登录总
移动终端登
录总人次
英文名称
trainingOrganization-
currentDate
yesterdayLogin
CountSum
PVcurrentLogin-
CountSum
loginCountSum
yesterdayMobile
LoginCountSum
mobilePVcurrent
LoginCountSum
mobileLoginCount
登录人次统计数据接口请求表
培训机构使用的组织
机构标识符
统计数据的日期
平台当日的前一天累
计的登录人次
平台当日登录的总
平台登录的总人次
平台当日的前一天累
计的登录人次
平台当日登录的总
移动终端登录平台的
总人次
注:“约束”栏内M表示\必备”数据元素.O表示\可选”数据元素。8.2.1.2
页面浏览量统计数据接口
页面浏览量统计数据接口的基本信息包括:GB/T
7408—2005
数据类型
接口说明:服务提供方向服务发起方上传本平台页面浏览量统计数据:实时性要求:无;
接口参数:页面浏览量统计数据接口参数见表14;接口请求:页面浏览量统计数据的接口请求见表15.请求样例参见A.6;接口响应:页面浏览量统计数据的接口响应见表3,响应样例参见A.7。AC
接口地址
body.type
表14页面浏览量统计数据接口参数表值
https://HOST)/data/push
visitStat
数据格式为
YYYYMMDD
含移动端
含移动端
含移动端
中文名称
培训机构标
当日前累计平
台访问总人次
当日平台访间
总人次
平台访问总
页面浏览量统计数据接口请求表英文名称
trainingOrganizationID
currentDate
yesterdayPVCountSum
PVeurrentCountSum
PVcountSum
注:“约束”栏内M表示“必备”数据元素8.2.1.3
首页访问量统计数据接口
见表13的2.1
见表13的2.2
干部网络培训平台当日的前
天累计的总页面浏览量
平台当日的总页面浏览数
平台的总页面浏览数
首页访问量统计数据接口的基本信息包括:约束
接口说明:服务提供方向服务发起方上传本平台首页访问量统计数据:实时性要求:无;
接口参数:首页访问量统计数据接口参数见表16;GB/T38863—2020
数据类型
接口请求:首页访问量统计数据的接口请求见表17,请求样例参见A.6;接口响应:首页访问量统计数据的接口响应见表3,响应样例参见A.7。表16
首页访问量统计数据接口参数表教
接口地址
body.type
中文名称
培训机构标识符
当日前累计平台首页
访间总人次
当日首页访问总人次
平台首页访问总人次
https://HOST//data/push
PVstat
首页访问量统计数据接口请求表表17
英文名称
trainingOrganizationID
currentDate
yesterdayPV
PVcurrent
见表13的2.1
见表13的2.2
本平台当日的前一天累计的
首页访间量
平台当日首页面的浏览数
平台首页面的浏览数
注:“约束”栏内M表示\必备”数据元素.O表示“可选”数据元素。约束
课程浏览数
不计算在内
数据类型
小提示:此标准内容仅展示完整标准里的部分截取内容,若需要完整标准请到上方自行免费下载完整标准文档。