2020体化指挥调度 应用支撑接口技术要求.docx
《2020体化指挥调度 应用支撑接口技术要求.docx》由会员分享,可在线阅读,更多相关《2020体化指挥调度 应用支撑接口技术要求.docx(101页珍藏版)》请在三一办公上搜索。
1、一体化指挥调度应用支撑接口技术要求前言II1范围12规范性引用文件13术语和定义14总体框架25角色支撑类接口26消息支撑类接口87组织机构支撑类接口98位置支撑类接口149任务支撑类接口15附录A(规范性附录)角色支撑类接口定义19附录B(规范性附录)消息支撑类接口定义43附录C(规范性附录)组织机构支撑类接口定义48附录D(规范性附录)位置支撑类接口定义73附录E(规范性附录)任务支撑类接口定义79一体化指挥调度应用支撑接口技术要求1范围本标准规定了一体化指挥调度系统中应用支撑平台对应用软件提供的角色支撑类、消息支撑类、组织机构支撑类、位置支撑类和任务支撑类接口的技术要求。本标准适用于一体
2、化指挥调度应用的开发活动。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注口期的引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T11457信息技术软件工程术语ECMA标准-262(第八版)ECMAScript()2017语言规范国家电子政务工程建设项目管理暂行办法2007年第55号令GBT28174.2-2011统一建模语言(UML)第2部分:上层结构3术语和定义ECMA标准、国家电子政务工程建设项目管理暂行办法、GBT28174.2-2011中界定的术语和定义适用于本文件。3.13.1公共角色commonrole多
3、个应用软件共同使用的角色。3.23.2组织机构唯一标识OrganiZatiOncode特指体化指挥调度应用支撑平台内机构对象的唯一标识,可以是统一社会信用代码,也可以由平台自定义。3.33.3任务task通常指交派的工作,具有明确的目的性。在一体化指挥调度领域中,任务包括日常、应急以及专项活动等场景下的任务。4总体框架一体化指挥调度应用支撑平台向应用软件提供的支撑接口划分为:角色支撑类接口、消息支撑类接口、组织机构支撑类接口、位置支撑类接口以及任务支撑类接口。如图1所示。遵循GBT28174.22011中提供的接口绘制方法,供接口用“棒棒糖”式的图形表示,即由一个封闭的圆形与一条直线组成;需接
4、口用“插座”式的图形表示,即由一个半圆与一条直线组成。其中,。表示提供接口,表示请求接口。应用软件位置支撑类接口 co- 组织机构支撑类接口 (O- 皆心支重接口co- 角色支撑类接口任务支塞接口应用支撑平台图1一体化指挥调度应用支撑平台与应用软件接口关系示意图5角色支撑类接口5.1 概述角色支撑类接口主要包含所有公共角色信息查询接口、应用和公共角色绑定接口、应用已经绑定的公共角色查询接口、应用角色新增接口、应用角色组织人员信息获取接口、应用角色组织人员关系新增或更新接口、应用角色组织人员关系删除接口以及人员拥有应用角色(含公共角色)获取接口。5.2 所有公共角色信息查询本接口可以查询所有公共
5、角色的信息。表1所有公共角色信息查询响应参数表序号参数标识参数名称描述1idi,唯一标识2CreateDate创建日期公共角色的创建Fl期3UpdateDate更新日期公共角色的更新日期4roleCode角色编号每个公共角色对应的唯一编号5roleName角色中文名称公共角色的中文名称6FoleEnname角色英文名称公共角色的英文名称7groupLevels可授权行政等级该行政等级下所有机构可使用当前公共角色:-1全部0000OOlO部0000OlOO省OOOO1000地级市OOOl0000区县8userNum限制人数限定该公共角色可绑定的人数其中T表示不限制人数9enpowerType授权
6、类型该角色可授权的用户类型:0不限制1只支持个人2只支持组织10instruction说明公共角色描述11success是否成功IrUe:成功false:失败12message返回信息描述当前状态原因(主要获取绑定失败原因)查询所有公共角色信息接口响应参数的JSoNSChema见附录A。5.3 应用和公共角色绑定本接口可以使各应用在部署时绑定所需的公共角色,使具有该应用角色属性的用户,可被授权使用该应用。表2各应用在部署时绑定公共角色请求参数表序号参数标识参数名称填写状态描述1appld应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3appName应用名称必填当前
7、应用的名称4PublicRoIeIds公共角色编号必填该应用所需绑定的所以公共角色的编号应用绑定公共角色接口请求参数的JSoNSChema定义见附录A。表3响应参数表序号参数标识参数名称描述1data数据执行绑定后,返回的绑定状态信息2success是否成功true:成功false:失败3message返回信息描述当前状态原因(主要获取绑定失败原因)应用绑定公共角色接口响应参数的JSoNSChema定义见附录A。5.4 应用己经绑定的公共角色查询该接口可以根据应用的ID及版本号查询该应用已经绑定的所有公共角色。表4应用己经绑定的公共角色查询请求参数表序号参数标识参数名称填写状态描述1appld
8、应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本查询应用已经绑定的公共角色接口请求参数的JSoNSChema定义见附录A。表5响应参数表序号参数标识参数名称描述1data数据返回已绑定的公共角色的编号2success是否成功true:成功false:失败3message返回信息描述当前状态原因(主要获取绑定失败原因)查询应用已经绑定的公共角色接口响应参数的JSONSChema定义见附录A。5.5 应用角色新增该接口可以根据应用需求,新增应用角色。表6应用角色新增请求参数表序号参数标识参数名称填写状态描述1叩Pld应用唯一标识必填该应用的唯一编号2version应用版
9、本号必填当前应用的版本3appRoleList应用角色列表必填应用角色的列表4type应用版本号必填0普通应用;I-组装应用5roleName应用角色名称必填当前应用角色名称6groupLevels可授权行政等级必填该行政等级下所有机构可使用当前应用角色-1全部(X)OOOOlO部00000100省0000100O地级市00010000区县7userNum限制人数必填限定拥有该应用角色其中-1表示不限制人数8enpowerType授权类型必填该角色可授权的用户类型:0不限制1只支持个人2只支持组织9instruction说明可选公共角色描述新增应用角色接l请求参数的JSONSChema定义见附
10、录A。表7响应参数表序号参数标识参数名称描述1data数据返回新增成功的条数2success操作是否成功true:成功false:失败3errorCole操作结果状态0:成功0:失败新增应用角色接口响应参数的JSoNSChema定义见附录A。5.6 应用角色组织人员信息获取可根据本接口获取所查询的用户的所有应用角色列表。表8应用角色组织人员信息获取请求参数表序号参数标识参数名称填写状态描述1ald应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3roleCode应用角色ID必填应用角色的唯一标识4orgCode组织编号可选当前组织编号,可根据组织编号查询该组织下的人
11、员信息5userid用户ID可选用户唯一标识获取应用角色组织人员信息接口请求参数的JSoNSChema定义见附录A。表9响应参数表序号参数标识参数名称描述1userid用户ID查询到的用户唯一标识2items角色编号应用角色编号3errorCode操作结果状态0:成功0:失败4success操作是否成功true:成功false:失败5HaveRoleCodeList该用户所拥有的应用角色该用户明细所拥有的应用角色列表获取应用角色组织人员信息接口响应参数的JSONSChema定义见附录A。5.7 应用角色组织人员关系新增或更新本接口可以完成应用角色组织人员关系新增或更新。表10应用角色组织人员关
12、系新增或更新请求参数表序号参数标识参数名称填写状态描述1appld应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3roleCode应用角色ID必填新增或修改的人员应用角色的唯一标识4orgCole组织编号必填新增或修改的人员所在组织5userid用户ID必填新增或修改的人员唯一标识应用角色组织人员关系新增或更新接口请求参数的JSoNSehema定义见附录A。表11响应参数表序号参数标识参数名称描述IerrorCode操作结果状态0:成功0:失败2success操作是否成功true:成功false:失败3msg返回信息描述当前状态原因(主要获取新增或更新失败原因)应
13、用角色组织人员关系新增或更新接口响应参数的JSONSChema定义见附录A。5.8 应用角色组织人员关系删除本接口可以完成应用角色组织人员关系删除。表12应用角色组织人员关系删除请求参数表序号参数标识参数名称填写状态描述1appld应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3roleCode应用角色ID必填需删除的人员的应用角色ID4orgCode组织编号必填需删除的人员所在组织5userids用户ID必填需删除人员用户ID应用角色组织人员关系删除接口请求参数的JSONSChema定义见附录A。表13响应参数表序号参数标识参数名称描述1errorCode操作结
14、果状态0:成功0:失败2success操作是否成功true:成功false:失败3data数据删除成功的记录数应用角色组织人员关系删除接口响应参数的JSONSChema定义见附录A。5.9 人员拥有应用角色(含公共角色)获取本接口可以获取人员所拥有的应用角色(含公共角色)。表14人员所拥有的应用角色获取请求参数表序号参数标识参数名称填写状态描述1叩PId应用唯一标识可选该应用的唯一编号2UserName用户名必填需查询的用户名3version应用版本号可选当前应用的版本4source来源必填区分普通应用和组装应用标志,一般是传null获取人员拥有应用角色接口请求参数的JSoNSChema定义见
15、附录A。表15响应参数表序号参数标识参数名称描述1paren(OrgCode父机构编码查询到的该用户所属的父级机构编码2ParentOrgName父机构名称查询到的该用户所属的父级机构名称3roleCode应用角色编码查询到的该用户所属应用角色编码4roleName应用角色名称查询到的该用户所属应用角色名称5roleOrgCode用户所属机构编码查询到的该用户所属机构编码6FoleOrgName用户所属机构名称查询到的该用户所属机构名称7PoliceName用户中文名查询到的用户中文名8userid主键返回用户唯一标识编号9UserName登录名返回用户名10UserType用户类型1指挥员/
16、作战人员用户2研发公司用户3社会公众用户4部门/机构用户5超级管理员用户6其他用户11message返回消息调用接口返回的消息12success是否成功true-成功;false-失败获取人员拥有应用角色接口响应参数的JSONSChema定义见附录A。注:参数标识是组成数组对象的键,参数名称是参数标识的中文意义,填写状态是对参数标识键值的填写要求,通常为必填和可选。描述是对参数名称的补充说明。正文参数表属性均参考本注释。6消息支撑类接口6.1 概述消息支撑类接口主要包含消息接收配置接口、消息类型校验接口以及消息推送初始化设置接口。6.2 消息接收配置本接口可以根据消息摘要、当前注册的应用信息等
17、进行配置消息接收。表16配置消息接收请求参数表序号参数标识参数名称填写状态描述1abstractlnfb消息摘要必填对消息简要的说明2appld应用ID必填当前注册应用的ID3appName应用名称可选当前注册应用的名称4msgType消息类型必填所接收的消息类型5msgTypeName消息类型名称可选所接收的消息类型名称6url链接地址必填访问注册应用的地址7orgCode部门编码必填部门编码消息接收配置接口请求参数的JSONSChema定义见附录B。表17响应参数表序号参数标识参数名称描述1errorCode操作结果状态0:成功0:失败2success操作是否成功true:成功false:
18、失败消息接收配置接口响应参数的JSONSChema定义见附录B。6.3 消息类型校验本接口可以根据输入的消息类型进行消息类型的校验。表18校验消息类型请求参数表序号参数标识参数名称填写状态描述1msgType消息类型必填所接收的消息类型消息类型校验接口请求参数的JSoNSChema定义见附录B。表19响应参数表序号参数标识参数名称描述1errorCode操作结果状态0:成功0:失败2msg返回信息描述当前状态原因(主要获取绑定失败原因)3success操作是否成功true:成功false:失败消息类型校验接口响应参数的JSoNSChema定义见附录B。6.4 消息推送初始化设置本接口可以初始化
19、设置推送消息。表20初始化设置推送消息请求参数表序号参数标识参数名称填写状态描述1appld应用ID必填注册的应用的ID2version应用版本必填注册的应用的版本号3msgType消息类型必填推送消息的类型4msgTypeName消息类型名称必填推送消息的类型的名称5appRoIeGrade应用角色等级列表必填角色编码与等级关系的集合6roleCode角色编码可选应用角色的编号7grade等级可选部门级别消息推送初始化设置接口请求参数的JSONSChema定义见附录B。表21响应参数表序号参数标识参数名称描述1errorCode操作结果状态0:成功0:失败2success操作是否成功true
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 2020体化指挥调度 应用支撑接口技术要求 2020 指挥 调度 应用 支撑 接口 技术 要求
链接地址:https://www.31ppt.com/p-6721859.html