电梯应急救援平台数据接口规范.docx

《电梯应急救援平台数据接口规范.docx》由会员分享，可在线阅读，更多相关《电梯应急救援平台数据接口规范.docx（42页珍藏版）》请在第一文库网上搜索。

1、电梯应急救援平台数据接口规范1范围本标准规定了电梯应急救援平台的数据交换架构、数据交换环境、数据交换模式、接口总则、接口响应状态编码、接口协议约定及协议清单、接口协议的内容。本标准适用于电梯应急救援平台的建设单位、研发单位的系统开发、平台对接、接口测试、系统验收工作。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GBZT7408数据元和交换格式信息交换日期和时间表示法TSG082017特种设备使用管理规则T/CPASEM001-2019电梯应急处置平台技术规范3术语和

2、定义下列术语和定义适用于本文件。（关于网格、电梯唯一标识、电梯使用单位等名词的定义）3. 1电梯Iifts,esca1atorsandmovingwa1ks动力驱动，利用沿刚性导轨运行的箱体或者沿固定线路运行的梯级（踏步），进行升降或者平行运送人、货物的机电设备，包括载人（货）电梯、自动扶梯、自动人行道等。4. 2使用单位theeIevatorunit对电梯使用履行安全管理义务、承担安全首负责任的单位或者个人。4数据交换架构省、市、及区县的电梯应急救援平台通过三级数据交换架构形式进行，省级平台为省级部门提供数据服务支撑，与市级各平台互联互通；市级平台为市级部门提供数据服务支撑，与各区县/地方平

3、台互联互通。数据交换架构如图1所示：图1数据交换架构体系图省级平台建立数据交换节点或通过前置机部署数据库，开通市级平台接口访问权限，完成与市级平台的数据交换；市级平台建立数据交换节点或通过前置机部署数据库，开通区县/地方平台接口访问权限，完成与各区县/地方平台的数据交换。5数据交换模式4.1 数据接口调用4.1.1 通过基于协议的接口调用实现数据交换注：适用于获取实时性、小数据包、结构化、非结构化、半结构化的数据，以及具备接口调用存储能力的系统。4.1.2 接口调用流程应符合图2的要求，详细的接口清单及约定内容见附件A电梯应急救援接口协议要求图2接口调用流程图注：适用于获取实时性、小数据包服务

4、方：即提供接口服务的一方；调用方：即需要进行接口调用的一方；调用方在首次调用接口前需预先提供调用方的相关信息，以获取服务方提供的用户识别码，根据用户识别码鉴权获取接口服务的授权码，从而进行接口的访问调用，返回的接口响应状态编码详情见第6章。4.2 数据抽取服务5.2.1通过数据抽取服务实现数据交换。注：一般用于数据量大、实时性要求不高、不具备接I1调用能力或局域网部署的周期性、结构化的数据场景。5.2.2数据库抽取的流程宜符合图3的要求，对接的数据内容见附件B电梯应急救援平台数据交换内容G根据数据交换标准如织数据人并写入节点机前置数据用根梃数据交换标准组织数据并写入节点机前置数据库交换通道前置

5、数据除据获取一-ft-交换传输控制-数据接收数据接收一节点1发送数据给节点2节点2发送数据给节点1图3数据抽取示意图数据提供方按照预先制定的标准数据结构写入数据,与数据接收方约定数据抽取规则并提供数据库访问权限，数据接收方按照约定内容进行数据抽取并同执数据获取状态。6接口基本要求6. 1同步异步接口使用原则采用同步方式进行接口交互。6.2 接口异常响应提示信息原则6. 2.1接口异常响应提示信息应符合以下原则：a）接口异常响应中，能够明确的错误信息一定要表述清楚，并记录把详细报错信息记录到日志。b）接口异常响应中的错误提示信息，应通俗易懂。c）错误日志中需要记录路由信息（包括请求唯一标识等），

6、供运维人员排查问题使用。6.3 前置库对接协同说明源数据提供方和目标数据接收方明确好表的结构、名称以及传输时间后，接收方应及时建表，并提供具有该表读写权限的账号信息，以及相对应的地址、端口、实例/库名称：源数据提供方按照给定的连接信息建立ET1脚本清洗、转换、抽取、同步程序。7接口响应状态编码接口响应状态编码要求如表1所示。表1接口响应状态码状态码说明200成功101路由字段不存在201服务器已经接受请求，但尚未处理202服务不可用203单次调用包大小超过指定阀值204流量超过阀值205调用频次过快206并发超过阀值207IP鉴权异常208授权码无效209授权码超时210报文转换异常301服务

7、端连接异常302服务端连接超时303服务端内部异常304服务端请求超时400服务器拒绝请求，不能理解请求语法401测试接口未实现404服务器拒绝请求，该服务不存在600服务器遇到错误，无法完成请求999未知异常附录A（规范性附录）电梯应急救援平台接口协议要求7.1 接口申报要求7.1.1 接口申报应符合如下要求：a）接口服务方需提供接口服务器地址及端口；b）协议格式：接口服务器地址:端口号/平台英文名称/分类英文名称/接口英文名称？authorization=授权码，其中分类名称和接口名称详情见15节，授权码在访问获取授权码时获得；例：接I1服务器地址:端口号/平台英文名称cogetDict?

8、authoriZation=O90988778899809（获取数据字典）c）用户识别码由XX台名称统一提供，接口对接期间长期有效；d）接口授权码是针对每个接口服务的，具有时效性限制，系统内限制为30分钟；e）接口数据模型定义的必填项必须提供；f）上传数据前应建立校验数据重复性的机制，避免数据重复插入；g）无特殊说明，接口默认采用PoST接口方法。7.2 接口日志记录要求接口调用方、接口提供方均应该对每次调用记录详细的日志，包括路由信息层和业务信息层的所有详细信息，以及接口调用的通讯情况做记录。日志记录后，可以根据请求唯一标识查询到详细的日志记录。7.3 接口异常处理要求各系统（包括接口调用方

9、、接M提供方）在捕获异常后，异常的处理遵循能处理就处理，不能处理就封装并向上传递，如果不能传递就告警并人工处理的原则。当调用接口时，如果因为网络异常等数据传输错误而造成数据未送达对端时，建议接口调用方进行一定数量的重试。当调用接口时，如果数据已经送达对端，因为数据本身存在错误而无法处理时，接口被调用方应该将详细的错误信息返回给接口调用方，并尽量明确的告知数据错误的具体原因。7.4 其他要求接口协议版本：协议版本为11及以上。字符集统一采用UTF-8格式；接口调用，单次文件包大小应小于30M7.5 协议清单分类名称英文名称说明通用应用comm包括获取授权码、数据字典、制造单位、维保/使用/单位、

10、救援/维保人员、上传文件电梯管理dtg1包括电梯的基础信息、安装/改造/修理信息、检验记录、使用登记（变更）/停用雇废/注销信息、运行参数信息救援管理jygi包括救援记录、救援网格信息统计管理tjgi电梯的相关统计指标分类接口名称英文名称说明通用应用获取授权码接口getTicket获取授权码以访问接口通用应用获取数据字典getDict获取数据字典，如电梯类别、品种、救援类型、故障类型等通用应用获取单位信息getrg1nfo获取电梯使用单位、维保单位、制造单位、设计单位信息通用应用获取人员信息getperators获取电梯维保人员、安全管理人员、检验人员、网格救援人员、救援客服的信息通用应用上传

11、文件接口upFi1e上传电梯证明材料、人员资质材料、单位资质材料电梯管理获取电梯基础信息getDt1ist包括电梯的设备类别、种类、品种、型号、使用单位、维保单位、使用状态、地址等获取电梯施工告知信息getDtReport包括历次的电梯安装改造维修告知信息获取电梯使用登记信息getDtRegister包括电梯历次的使用登记、变更情况获取电梯检验记录信息getDtCheck1nfo包括电梯的监检和定检记录获取电梯参数信息getDtParameter电梯层站数、运行速度等运行参数信息上传电梯救援记录UpDtSaveInfo电梯历次救援记录上传电梯救援网格信息UpDtRescueGrid电梯网格化信

12、息统计管理上传电梯累计运行情况UpDtWorkingInfo电梯累计运行次数、时间、故障数8接口协议内容8.1 通用应用1 .1.1获取授权码接口1.1.1.1 功能说明本接口用于获取系统授权码。数据服务商通过的PoST接口与电梯应急救援平台外部接口通信。1.1.1.2 接口地址:/服务器IP:服务器端口/系统简称commgetTicket1.1.1.3 1.1.3人参参数名类型可选标识参数描述UserCodeString必选用户识别码ServiceCodeString必选服务编码示例：(data:USerCode:用户识别码,ServiceCodeZServicer8.1.1.4出参参数名类

13、型可选标识参数描述dataString必选临时授权码rtString必选状态对象状态对象参数名类型可选标识参数描述fromSystemString必选数据来源系统msgString必选状态说明statusInteger必选状态码返回报文格式：（“data”:临时授权码rt:“fromSystem:“系统名称”，msg:“操作成功”，status:200）2 .1.2获取数据字典8 .1.2.1功能说明本接口用于获取数据字典，如电梯类别、品种、救援类型、故障类型等。数据服务商通过PoST接口与电梯应急救援平台外部接口通信。9 .1.2.2接口地址:服务器IP:C服务器端口/系统简称commget

14、Dict?authorizations授权码8.1.2.3人参参数名类型可选标识参数描述dataJson必选搜索对象搜索对象参数名类型可选标识参数描述typeString非必选字典类型，传入不同的type值获取不同的数据字典，电梯类别：EQUJYPE、电梯品种:EQUjaND、救援类型：MT_TYPE：故障类型：FA1rJTYPE示例:data:type/MTjrYPE)8.1.2.4出参参数名类型可选标识参数描述dataString必选分页对象rtString必选状态对象字典类型名称类型必填？说明备注idStringY编号1abe1StringY标签名va1ueStringY数据值typeStringY类型descriptionStringY描述sor