设备维护平台接口技术规范说明书

1、设备维护平台接口技术规范说 明书2013-05-13.设备维护平台接口技术规范说明书（版本号VI. 0）杭州天梦科技有限公司二。一o年五月更改履历版本号修 改 编 号更改时间更改 的 图表 和章 节更改简要描 述更改人批准人V1.02013-05-13创建，形成 初稿叶 庆1 <V1.12014-06-09维修业务操 作接口调 整，仅开放 维保单位相 关操作接口叶庆国注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式 进行修改。设备维护平台接口技术规范说明书1编写目的21.2预期读者2L3参考文献22 接口平台设计2技术架构接口架构图2业务流图3能部署方式4技术标准4鳌据

2、规约5示例63 WEBSERVICE 服务10设备维护平台提供黜艮务101011接口服务清单接口服务设计设备维护平台接口技术规范说明书1概述1编写目的为设备维护平台的信息同步和共享，制定了统一的接口规范，用来指导各系 统的接口设计、开发、联调及迁移工作。范围：本文档主要是对设备维护平台与外围业务系统的数据交互需求进行说 明。1.2 调试要求强烈要求第三方调用者，先做测试库的接口调试，确保接口及参数调用正确, 否则将对正式库可能出现的系统故障承担主要责任。1.3 预期读者项目组人员、各交互系统涉及到的开发厂家。1.4 参考文献智能交通设备维护管理系统设备接入标准杭州天梦科技有限公司2接口平台设计

3、2.1 技术架构2.1.1 接口架构图（暂缺）2设备维护平台接口技术规范说明书2.1.2业务流图4说明：用户通过接口。设备维护平台接口技术规范说明书2.2 部署方式接口服务层包括Webservice服务、展现集成服务。1、 Webservice 服务各系统提供的接口服务统一部署在设备维护平台接口服务层上，各系统客户 端和接口服务层用SOAP协议通过HTTP来交互，客户端根据WSDL描述文档 生成SOAP请求消息发送到服务端，服务端解析收到的SOAP请求，调用Web service,然后再生成相应的SOAP应答送回到客户端。2、 展现集成服务展现集成服务主要是应用界面集成服务，由服务提供方提供详

4、细的URL及相 关参数说明，调用方传入参数，调用服务方提供的页面进行展现。3、 平台Service组件服务平台Service组件服务统一部署在设备维护平台接口服务层上，通过平台接口 服务层进行查询操作。2.3 接口标准2.3.1 技术标准 简述客户端和服务器用SOAP协议通过HTTP来交互，客户端根据WSDL描述 文档生成SOAP请求消息发送到服务端，服务端解析收到的SOAP请求，调用 Web service,然后再生成相应的SOAP应答送回到客户端。 认证机制设备维护平台提供的所有WebService服务均需要认证授权才能被调用， Webservice服务接收到请

5、求后从传入参数中获取用户名和密码，进行认证，认证 通过后再调用具体服务。2.3.2 数据规约 简述客户端和服务端采用XML格式的字符串来交互业务数据，客户端将业务数 据组织成XML格式的字符串作为最后一个入参调用服务端接口，服务端解析XML 格式的字符串得到业务数据处理业务并把结果组织成XML格式的字符串返回给 客户端。接口调用的结果，自动序列化后，以XML格式的字符串返回，其中包含了 接口调用中出现的错误描述。23.2.2格式约定若是业务接口调用，将以DataItem_Rsp类实例序列化，表示单一数据项， 内容包括操作结果、错误描述，无数据集。若是查询接口调用，将以EntSet

6、Serialize_Rsp类实例序列化，表示查询 结果，其中包括错误描述，有数据集。XML 字符串中，若是节点取值为 null, Mft<BANK_CODE xsi：nil=*true*X/BANK_CODE>, 在节点中存在属性xsi: nil="true"；若是节点取值为空字符串，则是<bank_name/>。XML编码格式为“UTF-8”；字段为日期的遵循以下约定：1 .年月日格式统一为 “YYYY-MM-DD”，如 “2006-06-22”。2 .年月格式为 “YYYYMM”，如 “200606”。3 .包含时间的日期格式统一为“YYYY-M

7、M-DDTHH:MI:SS”，如 a2006-06-22114:00:004 .如果未约定日期格式，则DATE类型的默认为“YYYY-MM-DD”，如 “2006-06-22”。 格式 DTD暂缺233示例 2.331示例：查询接口，包含数据集<?xml version="l. 0" encoding="utf-8” ?> <EntSetSerialize_RspOfMNG_DATA_DICTIONARY xmlns:xsi="http :www, w3. org/2001/XMLSchem a-instance”xmln

8、s:xsd="http :www, w3. org/2001/XMLSchem a“ xmlns="http :tempuri. org/”><IsError>0</IsError><ErrorNo>0</ErrorNo><ErrorDesc> 操作成功 </ErrorDesc><TotalCount>3</TotalCount><RspCount>3</RspCount><RspPageSize>10</RspPageSize&g

9、t;<RspPageIndex>O</RspPageIndex><RspPageTotal>l</RspPageTotal><EntList><MNG_DATA_DICTIONARY><IsCreated>true</IsCreated><N0DE_GUID>e4fb99cf-108b-4688-bl24-43ae8a2 b5787</NODE_GUID><N0DE_NAME>可 控的故 障维修</N0DE_NAME><N0DE_C0DE>

10、900308010</N0DE_C0DE><N0DE_PARENT>ead3b6fb-0c5e-482c-892d-d629f57b75ef</N0DE_PARENT><NODE_VALUE /><NODE_LEVEL xsi:nil="true" /><N0DE_CATEG0RY>900501010</N0DE_CATEG0RY><N0DE_TYPE>900308010</N0DE_TYPE> <NODE_SORT>10</N0DE_S0RT>

11、; <ENABLE_STATE>k/ENABLE_STATE> <NODE_MEMO>可控的故障维</NODE_MEMO> <ADD_TIME>2011-09-26T17:20:17</ADD_TIME><UPDATE_TIME xsi:nib"true" /></MNG_DATA_DICTIONARY><MNG_DATA_DICTIONARY><IsCreated>true</IsCreated><N0DE_GUID>195a341c-

12、35dc-43ab-a2fc-b050bel2ea0c</N0DE GUID><N0DE_NAME>不可 控的故 障维修</N0DE_NAME><N0DE C0DE>900308020</N0DE C0DE><N0DE_PARENT>ead3b6fb-0c5e-482c-892d-d629f57b75ef</N0DE_PARENT><NODE_VALUE /><NODE_LEVEL xsi/><N0DE_CATEG0RY>900501010</N0DE_CATEG0RY

13、><N0DE_TYPE>900308020</N0DE_TYPE> <N0DE_S0RT>20</N0DE-S0RT> <ENABLE_STATE>1</ENABLE_STATE> <NODE_MEMO>不可控的故障维修</NODE_MEMO> <ADD_TIME>2011-09-26T17:20:32. 187</ADD_TIM E><UPDATE_TIME xsi:nil="true" /></MNG_DATA_DICTIONA

14、RY><MNG_DATA_DICTIONARY><IsCreated>true</IsCreated><N0DE_GUID>c648d4d3-9a7e-4f3f-8a2f-96f94cb 9d978</N0DE_GUID><N0DE_NAME> 频繁上下线 </N0DE_NAME><N0DE_C0DE>900308030</N0DE_C0DE><N0DE_PARENT>ead3b6fb-0c5e-482c-892d-d629f57b75ef</N0DE_PAREN

15、T><N0DE_VALUE /><N0DE_LEVEL xsi:nil=z，truezz /><N0DE_CATEG0RY>900501010</N0DE_CATEG0RY> <N0DE_TYPE>900308030</N0DE_TYPE> <N0DE_S0RT>22</N0DE_S0RT> <ENABLE_STATE>1</ENABLE_STATE> <NODE_MEMO> 频繁上下线 </NODE_MEMO><ADD_TIME>2

16、011-11-24T23:28:17. 953</ADD_TIM E><UPDATE_TIME xsi:nil="true" /></MNG_DATA_DICTIONARY></EntList></EntSetSerialize_RspOfMNG_DATA_DICTIONARY >2.33.2示例：业务接口，只有返回标识<?xml vers ionl. 0" encoding="utf-8” ?><DataItem_Rspxmlns:xsi="http:www. w3

17、. org/2001/XMLSchem a-instance”xmlns: xsd="zhttp: /www. w3. org/2001/XMLSchema' xmlns="http :tempuri. org/”><IsError>0</IsError><ErrorNo>0</ErrorNo><ErrorDesc>授权帐号验证失败</ErrorDesc>10设备维护平台接口技术规范说明书<ItemType>System. Boolean</ItemType><

18、;ItemValue>False</ItemValue></DataItem_Rsp>3 Webservice 月艮务3.1 设备维护平台提供的服务由于各用户单独安装部署，故对于WebService服务地址，另外单独提供。3.1.1接口服务清单序号服务名称接口名称说明调用方频率1ClientUserChec k客户端信息验证堇方实时2BaseData_DevLi st基础数据,设备 清单查询变实时3BaseData_OrgL ist基础数据,组织 机构及设备分组 清单查询第实时4BaseData_Dictio naryList基础数据.数据 字典代码项查询变实时5

19、DevRep_F aultSe arch业务流程.故障半小设备维护平台接口技术规范说明书上报查询方时6DevRep_F aultR eport故障上报变半小时7DevRep_RepairSearch业务流程,报修 查询斐半小时8DevRep_RepF eeApp维修报价申请斐半小时9DevRep_F aultR sp维修响应方半小时10DevRep_FaultF eedback维修反馈第1半小时11DevRep_Repair Audit维修审核半小时123.1.2接口服务设计客户端信息验证服务 名称ClientUserCheck口明 一接声.publicDataItem_RspC

20、lientUserCheck(string clientUser, string clientPwd, string clientlp)描述客户端信息验证中文名字段名长度类 型非空说明及数据 要求入参登录帐 号clientU serstringY登录密 码clientP wdstringY用户IPclientl PstringY出参IsError0：有错误；1：无错误ItemType数据项类型ItemValue数据项取值ErrorDesc错误描述部署 情况设备维护平台3.122基础数据，设备清单查询服务 名称BaseData_DevList接口public声明EntSetSerialize_R

21、sp<View_DEVICE_PURC HASE> BaseData_DevList(string devType, string devlp, string devGuid, string devCodeSdk? string devChannel, string unitRepGuid, Int32 pageindex, string clientUser, string clientPwd? string clientlp)描述基础数据,设备清单查询中文名字段名长度类 型非空说明及数据 要求入参设备类 型devTy pestringN设备IPdevlpstringN设备GUI

22、DdevGu idstringN设备接 口编号devCo deSdkstringN来自第三方 设备平台设备通 道号devCh annelstringN维保单 位 GUIDunitRe pGuidstringN作为维保方， 其登录帐号 所属单位 GUID,可作 为维保单位GUID页索引pagein dexInt32Y登录帐 号clientU serstringY登录密 码clientP wdstringY用户IPclientlPstringY出参IsError0：有错误； 1：无错误ErrorDesc错误描述TotalCount数据查询结果的总记录数RspCount实际返回的记录数RspPage

23、Size分页查询的页大小RspPagelndex分页查询的页索引RspPageTotal分页查询的页总数EntList数据查询结果列表,采用泛 型集合ListVT>,自动序 列化产生，根据查询接口不 同，其中嵌套的对象及其字 段名称也不同，以实际返回 结果为准部署 情况设备维护平台3.1.23基础数据，组织机构及设备分组查询服务 名称BaseData_OrgList口明 接声publicEntSetSerialize_Rsp<BASIC_ORG_DOMAI N> BaseData_OrgList(Int32 pageindex, string clientUser, stri

24、ng clientPwd, string clientlp)描述基础数据.组织机构及设备分组清单查询中文名字段名长度类 型非空说明及数据 要求页索引pagein dexInt32Y登录帐 号clientU serstringY登录密 码clientP wdstringY用户IPclientl PstringY出参IsError0：有错误；1：无错误ErrorDesc错误描述TotalCount数据查询结果的总记录数RspCount实际返回的记录数RspPageSize分页查询的页大小RspPagelndex分页查询的页索引RspPageTotal分页查询的页总数EntList数据查询结果列表,

25、采用泛 型集合ListVT>,自动序 列化产生，根据查询接口不 同，其中嵌套的对象及其字 段名称也不同，以实际返回 结果为准部署 情况设备维护平台基础数据，数据项查询月艮务 BaseData_DictionaryList 名称 接 口 public声明 EntSetSerialize Rsp<MNG DATA DICTIONARY >BaseData_DictionaryList(Int32pageindex, string nodeCategory, string nodeType,string clientUser, string clientPwd, st

26、ring clientlp)描述基础数据,数据字典代码项查询中文名字段名长度类 型非空说明及数据 要求页索引pagein dexInt32Y节点大 类nodeC ategor ystringY故障原因大 类-900501010故障原因细 类-900501020节点细 类nodeTypestringN登录帐 号clientU serstringY登录密 码clientP wdstringY用户IPclientl PstringY出参IsError0：有错误；1：无错误ErrorDesc错误描述TotalCount数据查询结果的总记录数RspCount实际返回的记录数RspPageSize分页查询

27、的页大小RspPagelndex分页查询的页索引RspPageTotal分页查询的页总数EntList数据查询结果列表,采用泛 型集合ListVT>,自动序 列化产生，根据查询接口不 同，其中嵌套的对象及其字 段名称也不同，以实际返回 结果为准部署 情况设备维护平台业务流程，故障上报查询服务 名称DevRep_F aultSearch口明 接声publicEntSetSerialize_Rsp<View_RECORD_FAU LT_REPAIR> DevRep_F aultSearch(string reportUnitGuid, string faultAud

28、itStatus, string devType, string faultType,string faultTimeStart, string faultTimeEnd, string repStatus, string jobNo, string deviceGuid, int pageindex,string clientUser, string clientPwd, string clientlp)描述业务流程.故障上报查询中文名字段名长度 类型非空说明及数据 要求入参上报单位reportUni tGuidstringN作为维保方， 其登录帐号GUID所属单位 GUID,可作 为上报单

29、位GUID故障审 核状态faultAuditStatusstrin gN设备类 型devTypestrin gN故障类 型faultTypestrin gN开始时 间faultTime Startstrin gN故障时间结束时 间faultTime Endstrin gN故障时间维修状 态repStatusstrin gN工单号jobNostrin gN设备GUIDdeviceGui dstrin gN页索引pageindexInt32Y登录帐 号clientUserstrin gY登录密 码clientPwdstrin gY用户IPclientlpstrinYg出参IsError0：有错误；

30、1:无错误ErrorDesc错误描述TotalCount数据查询结果的总记录数RspCount实际返回的记录数RspPageSize分页查询的页大小RspPagelndex分页查询的页索引RspPageTotal分页查询的页总数EntList数据查询结果列表,采用泛 型集合ListVT>,自动序 列化产生，根据查询接口不 同，其中嵌套的对象及其字 段名称也不同，以实际返回 结果为准设备维护平台3126业务流程，故障上报服务 名称DevRep_F aultReport口明 接声publicDataItem_RspDevRep_F aultReport(stringdeviceGuid,st

31、ring fault_Time, string fault_iype,string fault_Remark9 string clientUser, string clientPwd, string clientlp)描述故障上报中文名字段名长度类 型非空说明及数据 要求设备GUIDdevice GuidstringY故障时 间fault_ TimestringY故障类 型fault_ TypestringY故障类型编 号，可在数据 项中查询，参 考参数如下 节点大类，900501005节点细类， 900504050故障描 述fault_ Remar kstringY登录帐 号clientU

32、serstringY登录密 码clientP wdstringY用户IPclientl PstringY出参IsError0：有错误；1:无错误ItemType数据项类型ItemValue数据项取值ErrorDesc错误描述部署 情况设备维护平台30业务流程，报修查询服务 名称DevRep_RepairSear口明 接声publicEntSetSerialize_Rsp LT_REPAIR_UNIT: DevRep_RepairSear reportUnitGuid, st string devType, strin ,strin faultTimeEnd, stn jobNo,

33、 string device， ,stri clientPwd, string clic描述业务流程.报修查询中文名字段名入参上报单 位 GUIDreportUni tGuid维修移 交状态repTransf erStatus设备类devTypech<View_RECORD_FAU>ch(stringring repTransferStatus, ig faultTypeg faultTimeStart, string ing repStatus, string Guid, int pageindexing clientUser, string mtlp)长度 类型非空说明及数据

34、要求strin gN作为维保方， 其登录帐号 所属单位 GUID,可作 为上报单位 GUIDstrin gNstringN型故障类 型faultTypestrin gN开始时 间faultTime Startstrin gN故障时间结束时 间faultTime Endstrin gN故障时间维修状 态repStatusstrin gN工单号jobNostrin gN设备 GUIDdeviceGui dstrin gN页索引pageindexInt32Y登录帐 号clientUserstrin gY登录密 码clientPwdstrin gY用户IPclientlpstrin gY出参IsErr

35、or0：有错误；1:无错误ErrorDesc错误描述TotalCount数据查询结果的总记录数RspCount实际返回的记录数RspPageSize分页查询的页大小RspPagelndex分页查询的页索引RspPageTotal分页查询的页总数EntList数据查询结果列表,采用泛 型集合ListVT>,自动序列化产生，根据查询接口不 同，其中嵌套的对象及其字 段名称也不同，以实际返回 结果为准部署 情况设备维护平台3.L2.8业务流程，维修报价申请服务 名称DevRep_RepF eeApp口明 接声publicDataItem_RspDevRep_RepF eeApp(stringf

36、ault_Repair_Unit_Guid,stringrepFeeMemo, decimal repFee,string clientUsei; string dientPwd, string clientlp)描述维修报价申请中文名字段名长度 类型非空说明及数据 要求维修记 录 GUIDfault_Rep air_Unit_ Guidstrin gY申请描 述repFeeMe mostrin gY申请费 用repFeedeci malY登录帐号clientUserstrin gY登录密 码clientPwdstrin gY用户IPclientlpstrin gY出参IsError0：有错误

37、；1：无错误ItemType数据项类型ItemValue数据项取值ErrorDesc错误描述部署 情况设备维护平台业务流程，维修响应服务 名称DevRep_F aultRsp口明 接声publicDataItem_RspDevRep_F aultRsp(stringfault_Repair_Unit_Guid,stringfault_Reason_Memo,string clientUser, string clientPwd, string clientlp)描述维修响应中文名字段名长度 类型非空说明及数据 要求维修记 录 GUIDfault_Rep air_Unit_ Guidstrin gY维修响 应说明fault_Rea son_Mem ostrin gY登录帐 号clientUserstrin gY登录密 码clientPwdstrin gY用户IPclientlpstrin gY出参IsError0：有错误；1：无错误ItemType数据项类型I