《设备维护平台接口技术规范说明书[2013_05_13]》由会员分享，可在线阅读，更多相关《设备维护平台接口技术规范说明书[2013_05_13]（23页珍藏版）》请在金锄头文库上搜索。
1、. . 学习参考 设备维护设备维护平台 接口技术规术规范说说明书书 （版本号 V1.0） . . 学习参考 杭州天梦梦科技有限公司 二一年五月 . . 学习参考 更改履历 版本 号号 修改编编 号号 更改时间时间 更改的 图图表和章节节 更改简简要描述更改人批准人 V1.02013-05- 13 创建，形成初稿叶庆国 V1.12014-06- 09 维修业务操作接口调整， 仅开放维保单位相关操作 接口 叶庆国 注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式 进行修改。 . . 学习参考 目 录 1概概述2 1.1 编写目的2 1.2 预期读者2 1.3 参考文献2 2接口平
2、台设计设计.2 2.1 技术架构2 2.1.1 接口架构图.2 2.1.2 业务流图.3 2.2 部署方式4 2.3 接口标准4 2.3.1 技术标准.4 2.3.2 数据规约.5 2.3.3 示例6 3WEBSERVICE 服务务7 3.1 设备维护平台提供的服务7 3.1.1 接口服务清单7 3.1.2 接口服务设计8 . . 学习参考 1概述 1.1编写目的 为设备维护平台的信息同步和共享，制定了统一的接口规范，用来指导各系 统的接口设计、开发、联调及迁移工作。 范围：本文档主要是对设备维护平台与外围业务系统的数据交互需求进行说 明。 1.2调试要求 强烈要求第三方调用者，先做测试库的接
3、口调试，确保接口及参数调用正确， 否则将对正式库可能出现的系统故障承担主要责任。 1.3预期读者 项目组人员、各交互系统涉及到的开发厂家。 1.4参考文献 智能交通设备维护管理系统设备接入标准杭州天梦科技有限公司 2接口平台设计 2.1技术架构 2.1.1接口架构图 （暂缺） . . 学习参考 2.1.2业务流图 说明：用户通过接口。 . . 学习参考 2.2部署方式 接口服务层包括 Webservice 服务、展现集成服务。 1、Webservice 服务 各系统提供的接口服务统一部署在设备维护平台接口服务层上，各系统客户 端和接口服务层用 SOAP 协议通过 HTTP 来交互，客户端根据
4、WSDL 描述文档生 成 SOAP 请求消息发送到服务端，服务端解析收到的 SOAP 请求，调用 Web service，然后再生成相应的 SOAP 应答送回到客户端。 2、展现集成服务 展现集成服务主要是应用界面集成服务，由服务提供方提供详细的 URL 及相 关参数说明，调用方传入参数，调用服务方提供的页面进行展现。 3、平台 Service 组件服务 平台 Service 组件服务统一部署在设备维护平台接口服务层上，通过平台接 口服务层进行查询操作。 2.3接口标准 2.3.1技术标准 2.3.1.1 简述 客户端和服务器用 SOAP 协议通过 HTTP 来交互，客户端根据 WSDL 描述
5、文 档生成 SOAP 请求消息发送到服务端，服务端解析收到的 SOAP 请求，调用 Web service，然后再生成相应的 SOAP 应答送回到客户端。 . . 学习参考 2.3.1.2 认证机制 设备维护平台提供的所有 WebService 服务均需要认证授权才能被调用， Webservice 服务接收到请求后从传入参数中获取用户名和密码，进行认证，认证 通过后再调用具体服务。 2.3.2数据规约 2.3.2.1 简述 客户端和服务端采用 XML 格式的字符串来交互业务数据，客户端将业务 数据组织成 XML 格式的字符串作为最后一个入参调用服务端接口，服务端解 析 XML 格式的字符串得到
6、业务数据处理业务并把结果组织成 XML 格式的字符 串返回给客户端。 接口调用的结果，自动序列化后，以 XML 格式的字符串返回，其中包含 了接口调用中出现的错误描述。 2.3.2.2 格式约定 若是业务接口调用，将以 DataItem_Rsp 类实例序列化，表示单一数据项， 内容包括操作结果、错误描述，无数据集。 若是查询接口调用，将以 EntSetSerialize_Rsp 类实例序列化，表示查询结 果，其中包括错误描述，有数据集。 XML 字符串中，若是节点取值为null，则是，在节点中存在属性 xsi:nil=“true“；若是节点取值为空 字符串，则是。 . . 学习参考 XML 编
7、码格式为“UTF-8”； 字段为日期的遵循以下约定： 1.年月日格式统一为“YYYY-MM-DD”，如“2006-06-22”。 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 暂缺 2.3.3示例 2.3.3.1 示例：查询接口，包含数据集 0 0 操作成功 3 3 10 0 1 . . 学习参考 true e4fb99cf-10
8、8b-4688-b124-43ae8a2b5787 可控的故障维修 900308010 ead3b6fb-0c5e-482c-892d-d629f57b75ef 900501010 900308010 10 1 可控的故障维修 2011-09-26T17:20:17 true 195a341c-35dc-43ab-a2fc-b050be12ea0c 不可控的故障维修 900308020 ead3b6fb-0c5e-482c-892d-d629f57b75ef 900501010 900308020 20 1 不可控的故障维修 2011-09-26T17:20:32.187 true c648d
9、4d3-9a7e-4f3f-8a2f-96f94cb9d978 频繁上下线 900308030 ead3b6fb-0c5e-482c-892d-d629f57b75ef . . 学习参考 900501010 900308030 22 1 频繁上下线 2011-11-24T23:28:17.953 2.3.3.2 示例：业务接口，只有返回标识 0 0 授权帐权帐号号验证验证失败败 System.Boolean False 3Webservice 服务 3.1 设备维护平台提供的服务 由于各用户单独安装部署，故对于 WebService 服务地址，另外单独提供。 3.1.1接口服务清单 序 号 服
10、务名称接口名称说明调用方频率 1ClientUserCheck客户端信息验证第三方 实时 . . 学习参考 2BaseData_DevList基础数据.设备清单查询第三方 实时 3BaseData_OrgList基础数据.组织机构及设备分组 清单查询 第三方 实时 4BaseData_DictionaryList基础数据.数据字典代码项查询第三方 实时 5DevRep_FaultSearch业务流程.故障上报查询第三方半小时 6DevRep_FaultReport故障上报第三方半小时 7DevRep_RepairSearch业务流程.报修查询第三方半小时 8DevRep_RepFeeApp维修
11、报价申请第三方半小时 9DevRep_FaultRsp维修响应第三方半小时 10DevRep_FaultFeedback维修反馈第三方半小时 11DevRep_RepairAudit维修审核第三方半小时 12 3.1.2接口服务设计 3.1.2.1 客户端信息验证 服务名称ClientUserCheck 接口声明public DataItem_Rsp ClientUserCheck(string clientUser, string clientPwd, string clientIp) 描述客户端信息验证 中文名字段名长度类型非空说明及数据要求 登录帐号clientUserstringY 登
12、录密码clientPwdstringY 用户 IPclientIpstringY 入参 出参 IsError 0：有错误； 1：无错误 . . 学习参考 ItemType 数据项类型 ItemValue数据项取值 ErrorDesc错误描述 部署情况设备维护平台 3.1.2.2 基础数据，设备清单查询 服务名称BaseData_DevList 接口声明public EntSetSerialize_Rsp BaseData_DevList(string devType, string devIp, string devGuid, string devCodeSdk, string devChan
13、nel , string unitRepGuid, Int32 pageIndex, string clientUser, string clientPwd, string clientIp) 描述基础数据.设备清单查询 中文名字段名长度类型非空说明及数据要求 设备类型devTypestringN 设备 IPdevIpstringN 设备 GUIDdevGuidstring N 设备接口编号 devCodeSdkstring N 来自第三方设备平台 设备通道号devChannelstring N 维保单位 GUID unitRepGuidstring N作为维保方，其登录帐 号所属单位 GUI
14、D，可作 为维保单位 GUID 页索引pageIndexInt32Y 登录帐号clientUserstringY 登录密码clientPwdstringY 入参 用户 IPclientIpstringY IsError 0：有错误； 1：无错误 ErrorDesc错误描述 出参 TotalCount数据查询结果的总记录数 . . 学习参考 RspCount实际返回的记录数 RspPageSize分页查询的页大小 RspPageIndex分页查询的页索引 RspPageTotal分页查询的页总数 EntList 数据查询结果列表,采用泛 型集合 List，自动序 列化产生，根据查询接口 不同，其
15、中嵌套的对象及 其字段名称也不同，以实 际返回结果为准 部署情况设备维护平台 3.1.2.3 基础数据，组织机构及设备分组查询 服务名称BaseData_OrgList 接口声明public EntSetSerialize_Rsp BaseData_OrgList(Int32 pageIndex, string clientUser, string clientPwd, string clientIp) 描述基础数据.组织机构及设备分组清单查询 中文名字段名长度类型非空说明及数据要求 页索引pageIndexInt32Y 登录帐号clientUserstringY 登录密码clientPwds
16、tringY 用户 IPclientIpstringY IsError 0：有错误； 1：无错误 ErrorDesc错误描述 TotalCount数据查询结果的总记录数 RspCount实际返回的记录数 RspPageSize分页查询的页大小 RspPageIndex分页查询的页索引 RspPageTotal分页查询的页总数 出参 EntList 数据查询结果列表,采用泛 型集合 List，自动序 . . 学习参考 列化产生，根据查询接口 不同，其中嵌套的对象及 其字段名称也不同，以实 际返回结果为准 部署情况设备维护平台 3.1.2.4 基础数据，数据项查询 服务名称BaseData_DictionaryList 接口
