1、 设备维护平台接口技术规范说明书(版本号 V1.0)杭州天梦科技有限公司二一年五月更改履历版本号修改编号 更改时间更改的图表和章节 更改简要描述 更改人 批准人V1.0 2013-05-13 创建,形成初稿 叶庆国V1.1 2014-06-09 维修业务操作接口调整,仅开放维保单位相关操作接口叶庆国注:更改人除形成初稿,以后每次修改在未批准确认前均需采用修订的方式进行修改。设备维护平台接口技术规范说明书I目 录1 概述 .21.1 编写目的 .21.2 预期读者 .21.3 参考文献 .22 接口平台设计 .22.1 技术架构 .22.1.1 接口架构图 .22.1.2 业务流图 .32.2
2、部署方式 .42.3 接口标准 .42.3.1 技术标准 .42.3.2 数据规约 .52.3.3 示例 .63 WEBSERVICE 服务 .73.1 设备维护平台提供的服务 .73.1.1 接口服务清单 .73.1.2 接口服务设计 .8设备维护平台接口技术规范说明书21 概述1.1 编写目的为设备维护平台的信息同步和共享,制定了统一的接口规范,用来指导各系统的接口设计、开发、联调及迁移工作。范围:本文档主要是对设备维护平台与外围业务系统的数据交互需求进行说明。1.2 调试要求强烈要求第三方调用者,先做测试库的接口调试,确保接口及参数调用正确,否则将对正式库可能出现的系统故障承担主要责任。
3、1.3 预期读者项目组人员、各交互系统涉及到的开发厂家。1.4 参考文献智能交通设备维护管理系统设备接入标准 杭州天梦科技有限公司2 接口平台设计2.1 技术架构2.1.1 接口架构图(暂缺)设备维护平台接口技术规范说明书32.1.2 业务流图说明:用户通过接口。设备维护平台接口技术规范说明书42.2 部署方式接口服务层包括 Webservice 服务、展现集成服务。1、Webservice 服务各系统提供的接口服务统一部署在设备维护平台接口服务层上,各系统客户端和接口服务层用 SOAP 协议通过 HTTP 来交互,客户端根据 WSDL 描述文档生成 SOAP 请求消息发送到服务端,服务端解析
4、收到的 SOAP 请求,调用 Web service,然后再生成相应的 SOAP 应答送回到客户端。2、展现集成服务展现集成服务主要是应用界面集成服务,由服务提供方提供详细的 URL 及相关参数说明,调用方传入参数,调用服务方提供的页面进行展现。3、平台 Service 组件服务平台 Service 组件服务统一部署在设备维护平台接口服务层上,通过平台接口服务层进行查询操作。2.3 接口标准2.3.1 技术标准2.3.1.1 简述客户端和服务器用 SOAP 协议通过 HTTP 来交互,客户端根据 WSDL 描述文档生成 SOAP 请求消息发送到服务端,服务端解析收到的 SOAP 请求,调用 W
5、eb service,然后再生成相应的 SOAP 应答送回到客户端。2.3.1.2 认证机制设备维护平台提供的所有 WebService 服务均需要认证授权才能被调用,Webservice 服务接收到请求后从传入参数中获取用户名和密码,进行认证,认证通过后再调用具体服务。设备维护平台接口技术规范说明书52.3.2 数据规约2.3.2.1 简述客户端和服务端采用 XML 格式的字符串来交互业务数据,客户端将业务数据组织成 XML 格式的字符串作为最后一个入参调用服务端接口,服务端解析XML 格式的字符串得到业务数据处理业务并把结果组织成 XML 格式的字符串返回给客户端。接口调用的结果,自动序列
6、化后,以 XML 格式的字符串返回,其中包含了接口调用中出现的错误描述。 2.3.2.2 格式约定若是业务接口调用,将以 DataItem_Rsp 类实例序列化,表示单一数据项,内容包括操作结果、错误描述,无数据集。若是查询接口调用,将以 EntSetSerialize_Rsp 类实例序列化,表示查询结果,其中包括错误描述,有数据集。XML 字符串中,若是节点取值为 null,则是,在节点中存在属性 xsi:nil=“true“;若是节点取值为空字符串,则是。XML 编码格式为“UTF-8” ;字段为日期的遵循以下约定:1. 年月日格式统一为“YYYY-MM-DD” ,如“2006-06-22
7、” 。2. 年月格式为“YYYYMM” ,如“200606” 。3. 包含时间的日期格式统一为“YYYY-MM-DDTHH:MI:SS” ,如“2006-06-22T14:00:00”。4. 如果未约定日期格式,则 DATE 类型的默认为“YYYY-MM-DD” ,如“2006-06-22”。2.3.2.3 格式 DTD暂缺设备维护平台接口技术规范说明书62.3.3 示例2.3.3.1 示例:查询接口,包含数据集00操作成功331001truee4fb99cf-108b-4688-b124-43ae8a2b5787可控的故障维修900308010ead3b6fb-0c5e-482c-892d-
8、d629f57b75ef900501010900308010101可控的故障维修2011-09-26T17:20:17true195a341c-35dc-43ab-a2fc-b050be12ea0c不可控的故障维修900308020ead3b6fb-0c5e-482c-892d-d629f57b75ef900501010900308020201不可控的故障维修2011-09-26T17:20:32.187设备维护平台接口技术规范说明书7truec648d4d3-9a7e-4f3f-8a2f-96f94cb9d978频繁上下线900308030ead3b6fb-0c5e-482c-892d-d6
9、29f57b75ef900501010900308030221频繁上下线2011-11-24T23:28:17.9532.3.3.2 示例:业务接口,只有返回标识0 0 授权帐号验证失败 System.Boolean False 3 Webservice 服务3.1 设备维护平台提供的服务由于各用户单独安装部署,故对于 WebService 服务地址,另外单独提供。3.1.1 接口服务清单序号服务名称 接口名称 说明 调用方 频率1 ClientUserCheck 客户端信息验证 第三方 实时2 BaseData_DevList 基础数据.设备清单查询 第三方 实时3 BaseData_Org
10、List 基础数据.组织机构及设备分组清单查询第三方 实时设备维护平台接口技术规范说明书84 BaseData_DictionaryList 基础数据.数据字典代码项查询 第三方 实时5 DevRep_FaultSearch 业务流程.故障上报查询 第三方 半小时6 DevRep_FaultReport 故障上报 第三方 半小时7 DevRep_RepairSearch 业务流程.报修查询 第三方 半小时8 DevRep_RepFeeApp 维修报价申请 第三方 半小时9 DevRep_FaultRsp 维修响应 第三方 半小时10 DevRep_FaultFeedback 维修反馈 第三方
11、半小时11 DevRep_RepairAudit 维修审核 第三方 半小时123.1.2 接口服务设计3.1.2.1 客户端信息验证服务名称 ClientUserCheck接口声明 public DataItem_Rsp ClientUserCheck(string clientUser, string clientPwd, string clientIp)描述 客户端信息验证中文名 字段名 长度类型 非空 说明及数据要求登录帐号 clientUser string Y登录密码 clientPwd string Y用户 IP clientIp string Y入参IsError 0:有错误;1:无错误ItemType 数据项类型ItemValue 数据项取值出参ErrorDesc 错误描述部署情况 设备维护平台3.1.2.2 基础数据,设备清单查询服务名称 BaseData_DevList接口声明 public EntSetSerialize_Rsp BaseData_DevList(string