2020体化指挥调度 应用支撑接口技术要求.docx

一体化指挥调度应用支撑接口技术要求前言II1范围12规范性引用文件13术语和定义14总体框架25角色支撑类接口26消息支撑类接口87组织机构支撑类接口98位置支撑类接口149任务支撑类接口15附录A（规范性附录）角色支撑类接口定义19附录B（规范性附录）消息支撑类接口定义43附录C（规范性附录）组织机构支撑类接口定义48附录D（规范性附录）位置支撑类接口定义73附录E（规范性附录）任务支撑类接口定义79一体化指挥调度应用支撑接口技术要求1范围本标准规定了一体化指挥调度系统中应用支撑平台对应用软件提供的角色支撑类、消息支撑类、组织机构支撑类、位置支撑类和任务支撑类接口的技术要求。本标准适用于一体化指挥调度应用的开发活动。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注口期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。GB/T11457信息技术软件工程术语ECMA标准-262(第八版)ECMAScript()2017语言规范国家电子政务工程建设项目管理暂行办法2007年第55号令GBT28174.2-2011统一建模语言(UML)第2部分：上层结构3术语和定义ECMA标准、国家电子政务工程建设项目管理暂行办法、GBT28174.2-2011中界定的术语和定义适用于本文件。3.13.1公共角色commonrole多个应用软件共同使用的角色。3.23.2组织机构唯一标识OrganiZatiOncode特指体化指挥调度应用支撑平台内机构对象的唯一标识，可以是统一社会信用代码，也可以由平台自定义。3.33.3任务task通常指交派的工作，具有明确的目的性。在一体化指挥调度领域中，任务包括日常、应急以及专项活动等场景下的任务。4总体框架一体化指挥调度应用支撑平台向应用软件提供的支撑接口划分为：角色支撑类接口、消息支撑类接口、组织机构支撑类接口、位置支撑类接口以及任务支撑类接口。如图1所示。遵循GBT28174.22011中提供的接口绘制方法，供接口用“棒棒糖”式的图形表示，即由一个封闭的圆形与一条直线组成；需接口用“插座”式的图形表示，即由一个半圆与一条直线组成。其中，。表示提供接口，表示请求接口。应用软件位置支撑类接口 co- 组织机构支撑类接口 (O- 皆心支重接口co- 角色支撑类接口任务支塞接口应用支撑平台图1一体化指挥调度应用支撑平台与应用软件接口关系示意图5角色支撑类接口5.1 概述角色支撑类接口主要包含所有公共角色信息查询接口、应用和公共角色绑定接口、应用已经绑定的公共角色查询接口、应用角色新增接口、应用角色组织人员信息获取接口、应用角色组织人员关系新增或更新接口、应用角色组织人员关系删除接口以及人员拥有应用角色（含公共角色）获取接口。5.2 所有公共角色信息查询本接口可以查询所有公共角色的信息。表1所有公共角色信息查询响应参数表序号参数标识参数名称描述1idi,唯一标识2CreateDate创建日期公共角色的创建Fl期3UpdateDate更新日期公共角色的更新日期4roleCode角色编号每个公共角色对应的唯一编号5roleName角色中文名称公共角色的中文名称6FoleEnname角色英文名称公共角色的英文名称7groupLevels可授权行政等级该行政等级下所有机构可使用当前公共角色：-1全部0000OOlO部0000OlOO省OOOO1000地级市OOOl0000区县8userNum限制人数限定该公共角色可绑定的人数其中T表示不限制人数9enpowerType授权类型该角色可授权的用户类型：0不限制1只支持个人2只支持组织10instruction说明公共角色描述11success是否成功IrUe：成功false：失败12message返回信息描述当前状态原因（主要获取绑定失败原因）查询所有公共角色信息接口响应参数的JSoNSChema见附录A。5.3 应用和公共角色绑定本接口可以使各应用在部署时绑定所需的公共角色，使具有该应用角色属性的用户，可被授权使用该应用。表2各应用在部署时绑定公共角色请求参数表序号参数标识参数名称填写状态描述1appld应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3appName应用名称必填当前应用的名称4PublicRoIeIds公共角色编号必填该应用所需绑定的所以公共角色的编号应用绑定公共角色接口请求参数的JSoNSChema定义见附录A。表3响应参数表序号参数标识参数名称描述1data数据执行绑定后，返回的绑定状态信息2success是否成功true：成功false：失败3message返回信息描述当前状态原因（主要获取绑定失败原因）应用绑定公共角色接口响应参数的JSoNSChema定义见附录A。5.4 应用己经绑定的公共角色查询该接口可以根据应用的ID及版本号查询该应用已经绑定的所有公共角色。表4应用己经绑定的公共角色查询请求参数表序号参数标识参数名称填写状态描述1appld应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本查询应用已经绑定的公共角色接口请求参数的JSoNSChema定义见附录A。表5响应参数表序号参数标识参数名称描述1data数据返回已绑定的公共角色的编号2success是否成功true：成功false：失败3message返回信息描述当前状态原因（主要获取绑定失败原因）查询应用已经绑定的公共角色接口响应参数的JSONSChema定义见附录A。5.5 应用角色新增该接口可以根据应用需求，新增应用角色。表6应用角色新增请求参数表序号参数标识参数名称填写状态描述1叩Pld应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3appRoleList应用角色列表必填应用角色的列表4type应用版本号必填0普通应用；I-组装应用5roleName应用角色名称必填当前应用角色名称6groupLevels可授权行政等级必填该行政等级下所有机构可使用当前应用角色-1全部(X)OOOOlO部00000100省0000100O地级市00010000区县7userNum限制人数必填限定拥有该应用角色其中-1表示不限制人数8enpowerType授权类型必填该角色可授权的用户类型：0不限制1只支持个人2只支持组织9instruction说明可选公共角色描述新增应用角色接l请求参数的JSONSChema定义见附录A。表7响应参数表序号参数标识参数名称描述1data数据返回新增成功的条数2success操作是否成功true：成功false：失败3errorCo<le操作结果状态0：成功<0：失败新增应用角色接口响应参数的JSoNSChema定义见附录A。5.6 应用角色组织人员信息获取可根据本接口获取所查询的用户的所有应用角色列表。表8应用角色组织人员信息获取请求参数表序号参数标识参数名称填写状态描述1ald应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3roleCode应用角色ID必填应用角色的唯一标识4orgCode组织编号可选当前组织编号，可根据组织编号查询该组织下的人员信息5userid用户ID可选用户唯一标识获取应用角色组织人员信息接口请求参数的JSoNSChema定义见附录A。表9响应参数表序号参数标识参数名称描述1userid用户ID查询到的用户唯一标识2items角色编号应用角色编号3errorCode操作结果状态0：成功<0：失败4success操作是否成功true：成功false：失败5HaveRoleCodeList该用户所拥有的应用角色该用户明细所拥有的应用角色列表获取应用角色组织人员信息接口响应参数的JSONSChema定义见附录A。5.7 应用角色组织人员关系新增或更新本接口可以完成应用角色组织人员关系新增或更新。表10应用角色组织人员关系新增或更新请求参数表序号参数标识参数名称填写状态描述1appld应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3roleCode应用角色ID必填新增或修改的人员应用角色的唯一标识4orgCo<le组织编号必填新增或修改的人员所在组织5userid用户ID必填新增或修改的人员唯一标识应用角色组织人员关系新增或更新接口请求参数的JSoNSehema定义见附录A。表11响应参数表序号参数标识参数名称描述IerrorCode操作结果状态0：成功<0：失败2success操作是否成功true：成功false：失败3msg返回信息描述当前状态原因（主要获取新增或更新失败原因）应用角色组织人员关系新增或更新接口响应参数的JSONSChema定义见附录A。5.8 应用角色组织人员关系删除本接口可以完成应用角色组织人员关系删除。表12应用角色组织人员关系删除请求参数表序号参数标识参数名称填写状态描述1appld应用唯一标识必填该应用的唯一编号2version应用版本号必填当前应用的版本3roleCode应用角色ID必填需删除的人员的应用角色ID4orgCode组织编号必填需删除的人员所在组织5userids用户ID必填需删除人员用户ID应用角色组织人员关系删除接口请求参数的JSONSChema定义见附录A。表13响应参数表序号参数标识参数名称描述1errorCode操作结果状态0：成功<0：失败2success操作是否成功true：成功false：失败3data数据删除成功的记录数应用角色组织人员关系删除接口响应参数的JSONSChema定义见附录A。5.9 人员拥有应用角色（含公共角色）获取本接口可以获取人员所拥有的应用角色（含公共角色）。表14人员所拥有的应用角色获取请求参数表序号参数标识参数名称填写状态描述1叩PId应用唯一标识可选该应用的唯一编号2UserName用户名必填需查询的用户名3version应用版本号可选当前应用的版本4source来源必填区分普通应用和组装应用标志，一般是传null获取人员拥有应用角色接口请求参数的JSoNSChema定义见附录A。表15响应参数表序号参数标识参数名称描述1paren(OrgCode父机构编码查询到的该用户所属的父级机构编码2ParentOrgName父机构名称查询到的该用户所属的父级机构名称3roleCode应用角色编码查询到的该用户所属应用角色编码4roleName应用角色名称查询到的该用户所属应用角色名称5roleOrgCode用户所属机构编码查询到的该用户所属机构编码6FoleOrgName用户所属机构名称查询到的该用户所属机构名称7PoliceName用户中文名查询到的用户中文名8userid主键返回用户唯一标识编号9UserName登录名返回用户名10UserType用户类型1指挥员/作战人员用户2研发公司用户3社会公众用户4部门/机构用户5超级管理员用户6其他用户11message返回消息调用接口返回的消息12success是否成功true-成功；false-失败获取人员拥有应用角色接口响应参数的JSONSChema定义见附录A。注：参数标识是组成数组对象的键，参数名称是参数标识的中文意义，填写状态是对参数标识键值的填写要求，通常为必填和可选。描述是对参数名称的补充说明。正文参数表属性均参考本注释。6消息支撑类接口6.1 概述消息支撑类接口主要包含消息接收配置接口、消息类型校验接口以及消息推送初始化设置接口。6.2 消息接收配置本接口可以根据消息摘要、当前注册的应用信息等进行配置消息接收。表16配置消息接收请求参数表序号参数标识参数名称填写状态描述1abstractlnfb消息摘要必填对消息简要的说明2appld应用ID必填当前注册应用的ID3appName应用名称可选当前注册应用的名称4msgType消息类型必填所接收的消息类型5msgTypeName消息类型名称可选所接收的消息类型名称6url链接地址必填访问注册应用的地址7orgCode部门编码必填部门编码消息接收配置接口请求参数的JSONSChema定义见附录B。表17响应参数表序号参数标识参数名称描述1errorCode操作结果状态0：成功<0：失败2success操作是否成功true：成功false：失败消息接收配置接口响应参数的JSONSChema定义见附录B。6.3 消息类型校验本接口可以根据输入的消息类型进行消息类型的校验。表18校验消息类型请求参数表序号参数标识参数名称填写状态描述1msgType消息类型必填所接收的消息类型消息类型校验接口请求参数的JSoNSChema定义见附录B。表19响应参数表序号参数标识参数名称描述1errorCode操作结果状态0：成功<0：失败2msg返回信息描述当前状态原因（主要获取绑定失败原因）3success操作是否成功true：成功false：失败消息类型校验接口响应参数的JSoNSChema定义见附录B。6.4 消息推送初始化设置本接口可以初始化设置推送消息。表20初始化设置推送消息请求参数表序号参数标识参数名称填写状态描述1appld应用ID必填注册的应用的ID2version应用版本必填注册的应用的版本号3msgType消息类型必填推送消息的类型4msgTypeName消息类型名称必填推送消息的类型的名称5appRoIeGrade应用角色等级列表必填角色编码与等级关系的集合6roleCode角色编码可选应用角色的编号7grade等级可选部门级别消息推送初始化设置接口请求参数的JSONSChema定义见附录B。表21响应参数表序号参数标识参数名称描述1errorCode操作结果状态0：成功<0：失败2success操作是否成功true：成功false：失败消息推送初始化设置接口响应参数的JSoNSChema定义见附录B。7组织机构支撑类接口7.1 概述组织机构支撑类接口主要包含根据组织机构唯标识查询组织机构信息接口、根据组织机构代码查询组织机构信息接口、所有组织机构数据查询接口、根据机构表主键获取组织机构信息接口、根据组织机构唯一标识找出该组织子节点直至叶子节点接口、根据机构代码查询该节点下所有人员接口、根据机构查询接口以及根据机构唯一标识获取机构下的领导信息接口。7.2 根据组织机构唯一标识查询组织机构信息本接口可根据组织机构唯一标识查询组织信息。表22根据组织机构唯一标识查询组织机构信息响应参数表序号参数标识参数名称描述1name机构名所查询的机构名称2OrganizationCode组织机构代码所查询的机构代码3organization组织机构ID长度20,所查询的机构id4ParentOrganizationCode父级组织代码所查询的父级机构代码5ParenIorganiZalionName父级组织名称所查询的父级机构名称6errorCode操作结果状态0：成功<0：失败7success操作是否成功true：成功false：失败根据组织机构唯一标识查询组织机构信息接口响应参数的JSONSChema定义见附录C。7.3 根据组织机构唯一标识查询组织机构信息本接口可根据组织机构代码查询组织机构信息。表23根据组织机构唯一标识查询组织机构信息响应参数表序号参数标识参数名称描述1name机构名所查询的机构名称2OrganizationCode组织机构唯一标识所查询的机构代码3OrganizationId组织机构ID长度20,所查询的机构id4ParentOrganizationCode父级组织代码所查询的父级机构代码5errorCode操作结果状态0：成功<0：失败6success操作是否成功true：成功false：失败根据组织机构唯标识查询组织信息接口响应参数的JSoNSChema定义见附录C。7.4 所有组织机构数据查询本接口可查询所有组织机构数据。表24所有数据查询响应参数表序号参数标识参数名称描述1name机构名所查询的机构名称2OrganizationCode组织机构唯标识所查询的机构代码3OrganizationId组织机构ID长度20,所查询的机构id4ParentOrganizationCode父级组织代码所查询的父级机构代码5ParentOrganizationName父级组织名称所查询的父级机构名称6errorCode操作结果状态0：成功<0：失败7success操作是否成功true：成功false：失败查询所有组织机构数据接口响应参数的JSONSChema定义见附录C。7.5 根据机构表主键获取组织机构信息本接口可根据机构表主键获取组织机构信息。表25根据机构表主键获取组织机构信息响应参数表序号参数标识参数名称描述1name机构名所查询的机构名称2OrganizationCode组织机构唯标识所查询的机构代码3ParentOrganizationCode父级组织代码所查询的父级机构代码4organization组织机构ID所查询的机构id5errorCode操作结果状态0：成功<0：失败6success操作是否成功true：成功false：失败根据机构表主键获取组织信息接口响应参数的JSoNSChema定义见附录C。7.6 根据组织机构唯一标识找出该组织子节点直至叶子节点本接口可根据组织机构唯一标识找出该组织子节点直至叶子节点。表26根据机构代码找出该组织子节点直至叶子节点响应参数表序号参数标识参数名称描述1name机构名所查询的机构名称2OrganizationCode组织机构唯一标识所查询的机构代码3ParentOrganizationCode父级组织代码所查询的父级机构代码4ParentOrganizationName父级组织名称长度100,所查询的父级机构名称5OrganizationId组织机构ID所查询的机构id6errorCode操作结果状态0：成功<0：失败7success操作是否成功true：成功false：失败根据组织机构唯标识找出该组织子节点直至叶子节点接口响应参数的JSONSChema定义见附录C。7.7 根据机构代码查询该节点下所有人员本接口可以根据机构代码查询该节点下所有人员。表27根据机构代码查询该节点下所有人员响应参数表序号参数标识参数名称描述1userid用户表主键所查询的用户表主键2ScreenName登录名所查询的登录名3firstName用户名所查询的用户名4identity身份证号码所查询的身份证号码5policeCode用户编号所查询的用户编号6success操作结果状态0：成功<0：失败7errorCode操作是否成功true：成功false：失败根据组织机构唯标识查询该节点下所有人员接口响应参数的JSoNSChema定义见附录C。7.8 根机构查询本接口可以根据根机构信息，查询下级机构信息。表28根机构查询接口响应参数表序号参数标识参数名称描述1id机构编码所查询的机构编码2remarks备注备注3UpdateDate更新日期更新日期4parentlds所有父级机构编码的组合所有父级机构编码的组合，以逗号分开5areniName父级机构名称父级机构名称6name机构名称机构名称7sort排序排序8oid主键主键9code编码编码10type类型1第三方公司；2政府部门11grade级别I总队（省）2支队（市）3大队（县）4中队（所）12address地址地址13zipCode邮政编码邮政编码14master负责人负责人15phone电话电话16mobile手机手机17fax传真传真18email邮箱邮箱19useable是否可用是否可用20radio电台信道电台信道21kinds机构类型机构类型：0政府部门1内设执法勤务机构2内设综合管理机构3执行机构4临时机构（任务无关）5临时机构（任务相关）6现役机构22parentld父级机构编码父级机构编码23treeRefresh是否刷新true：是false：否24fullName机构全名机构全名25UserFIag是否生成用户标识0:创建用户1:不创建用户26success操作结果状态0：成功<0：失败27errorCode操作是否成功true：成功false：失败根机构查询接l响应参数的JSONSehema定义见附录C。7.9 根据机构唯一标识获取机构下的领导信息本接口可以根据机构唯一标识获取机构下的领导信息。表29根据机构唯一标识获取机构下的领导信息接口响应参数表序号参数标识参数名称描述1id主键主键2name姓名姓名3position岗位岗位4officeld机构编码机构编码5OfficeName机构简称机构简称6OfficeFullName机构全称机构全称7sex性别1女0男8post职位职位9success操作是否成功true：成功false：失败10message接口返回的消息接口返回的消息根据机构唯一标识获取机构下的领导信息接口响应参数的JSoNSChema定义见附录C。8位置支撑类接口8.1 概述位置支撑类接口主要包含根据登录名获取行政区划信息接口以及根据具体的行政区划代码获取下一级行政区划信息接口。8.2 根据登录名获取行政区划信息本接口可以根据登录名获取行政区划信息。表30根据登录名获取行政区划信息响应参数表序号参数标识参数名称描述1CoUntry国家国家2code国家编码国家编码3name国家名称国家名称4province省或直辖市省或直辖市5code省或直辖市编码省或直辖市编码6name省或直辖市名称省或直辖市名称7city城市城市8code城市编码城市编码9name城市名称城市名称10county区县4r11code区县编码区县编码12name区县名称区县名称13success操作是否成功true：成功false：失败14message接口返回的消息接口返回的消息根据登录名获取行政区划信息接口响应参数的JSoNSChema定义见附录D。8.3 根据具体的行政区划代码获取下一级行政区划信息本接口可以根据具体的行政区划代码获取下一级行政区划信息。表31根据具体的行政区划代码获取下一级行政区划信息响应参数表序号参数标识参数名称描述1code下级行政区划编码下级行政区划编码2name下级行政区划名称下级行政区划名称3code父级行政区划编码父级行政区划编码4success操作是否成功true：成功false：失败5message接口返回的消息接口返回的消息根据具体的行政区划代码获取下一级行政区划信息接口响应参数的JSONSChema定义见附录DC9任务支撑类接口9.1 概述任务支撑类接口主要包含根据城市编码查询所有的任务详情接口、根据任务ID查询所有的任务详情接口、根据任务ID查询此任务所绑定的应用详情接口以及根据登录名获取用户有权限的任务接口。9.2 根据城市编码查询所有的任务详情本接口可以根据城市编码查询所有的任务详情。表32根据城市编码查询所有的任务详情请求参数表序号参数标识参数名称填写状态描述1code城市编码必填任务城市的编码根据城市编码查询所有的任务详情接口请求参数的JSONSChema定义见附录D。表33响应参数表序号参数标识参数名称描述1id任务主键任务主键2name任务名称任务名称3displayName展示名称展示名称4discription描述任务描述5taskType任务类型1专项2应急3日常6imageThumb纯图标纯图标7image带文字图标带文字图标8latitude经度经度9longitude纬度纬度10mapLevel地图级别地图级别11StartTime开始日期开始日期12endTime结束日期结束日期13available是否启用0:否1：是14CityCode城市编码城市编码15CreateUser创建人创建人16CreateTime创建时间创建时间17UpdateUser更新人更新人18LipdateTime更新时间更新时间19success操作是否成功ti-ue：成功false：失败20message接11返回的消息接1返回的消息根据城市编码查询所有的任务详情接口响应求参数的JSoNSChema定义见附录E。93根据任务ID查询所有的任务详情本接口可以根据任务ID查询所有的任务详情。表34根据任务ID查询所有的任务详情请求参数表序号参数标识参数名称填写状态描述1id任务ID必填任务ID根据任务ID查询所有的任务详情接口请求参数的JSONSChema定义见附录E。表35响应参数表序号参数标识参数名称描述1id任务主键任务主键2name任务名称任务名称3displayName展示名称展示名称4discription描述描述5IaskType任务类型1专项2应急3日常6imageThumb纯图标纯图标7image带文字图标带文字图标8latitude经度经度9longitude纬度纬度10mapLevel地图级别地图级别11StartTime开始日期开始日期12endTime结束日期结束日期13available是否启用0:否1：是14CityCode城市编码城市编码15CreateUser创建人创建人16CreateTime创建时间创建时间17UpdateUser更新人更新人18LipdateTime更新时间更新时间19success操作是否成功ti-ue：成功false：失败20message接口返回的消息接口返回的消息根据任务ID查询所有的任务详情接l响应参数的JSONSChema定义见附录E。9.4 根据任务ID查询此任务所绑定的应用详情本接口可以根据任务ID查询此任务所绑定的应用详情。表36根据任务TD查询此任务所绑定的应用详情请求参数表序号参数标识参数名称填写状态描述1id任务ID必填任务ID根据任务ID查询此任务所绑定的应用详情接口请求参数的JSONSChema定义见附录E。表37响应参数表序号参数标识参数名称描述1id主键应用主键2appld应用ID应用ID3appName应用名称应用名称4appDesc应用描述应用描述5IogoWebWEB端应用图标WEB端应用图标6IogoApp移动端应用图标移动端应用图标7version应用版本应用版本8StoreLocation存储路径存储路径9apprg应用机构编码应用机构编码10appOrgName应用机构名称应用机构名称11UpIoadBy上传人ID上传人ID12UpIoadByName上传人姓名上传人姓名13appCategory应用技术分类应用技术分类14bizCategory应用业务分类应用业务分类15aaType类型类型shirour(default)hybrid16url访问UrI访问Url17RinStatus运行状态运行状态0：未运行1：已运行2：运行异常18status管理状态管理状态0：已部署1：已发布2：卸载中3：已卸载4:切换中5：已关闭19CreateBy创建人创建人20CreateTime创建时间创建时间21appType应用类型应用类型22HppIntegrateType应用集成类型应用集成类型INDEPENDENT.NORMAL.DEEP23success操作是否成功true：成功false：失败24message接口返回的消息接口返回的消息根据任务ID查询此任务所绑定的应用详情接口响应参数的JSONSChema定义见附录J9.5 根据登录名获取用户有权限的任务本接口可以根据登录名获取用户有权限的任务。表38根据登录名获取用户有权限的任务请求参数表序号参数标识参数名称填写状态描述1name登录名必填登录名根据登录名获取用户有权限的任务接口请求参数的JSONSChema定义见附录E。表39响应参数表序号参数标识参数名称描述1id任务ID任务ID2name任务名称任务名称3errorCode操作结果状态0：成功<0：失败4success操作是否成功true：成功false：失败根据登录名获取用户有权限的任务接口响应参数的JSONSChema定义见附录E。附录A（规范性附录）角色支撑类接口定义1所有公共角色信息查询响应参数：("definitions":,"Sschema":"http:/json-schema.0rg/draft-O6/