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

1、设施保护平台接口技术规范说明书2013-05-13.设施保护平台接口技术规范说明书2013-05-13.24/24设施保护平台接口技术规范说明书2013-05-13.设施保护平台接口技术规范说明书（版本号V1.0）杭州天梦科技有限企业二一年五月改正简历版本改正编改正的改正人同意人号改正时间改正简要描绘号图表和章节V1.02013-05-13创立，形成稿本叶庆国V1.12014-06-09维修业务操作接口调整，仅叶庆国开放维保单位有关操作接口注：改正人除形成稿本，此后每次改正在未批正确认前均需采纳订正的方式进行改正。设施保护平台接口技术规范说明书目录1概括21.1编写目的21.2预期读者21.3

2、参照文件22接口平台设计22.1技术架构2接口架构图2业务流图32.2部署方式42.3接口标准4技术标准4数据规约5示例63WEBSERVICE服务73.1设施保护平台供给的服务7接口服务清单7接口服务设计8I设施保护平台接口技术规范说明书概括1.1编写目的为设施保护平台的信息同步和共享，制定了一致的接口规范，用来指导各系统的接口设计、开发、联调及迁徙工作。范围：本文档主假如对设施保护平台与外头业务系统的数据交互需求进行说明。1.2调试要求激烈要求第三方调用者，先做测试库的接口调试，保证接口及参数调用正确，不然将对正式库可能出现的系统故障担当主要责任。1.3预期读者项目组人员、各交互系统波及到

3、的开发厂家。1.4参照文件智能交通设施保护管理系统设施接入标准杭州天梦科技有限企业接口平台设计2.1技术架构接口架构图（暂缺）2设施保护平台接口技术规范说明书业务流图说明：用户经过接口。3设施保护平台接口技术规范说明书2.2部署方式接口服务层包含Webservice服务、显现集成服务。1、Webservice服务各系统供给的接口服务一致部署在设施保护平台接口服务层上，各系统客户端和接口服务层用SOAP协议经过HTTP来交互，客户端依据WSDL描绘文档生成SOAP恳求信息发送到服务端，服务端分析收到的SOAP恳求，调用Webservice，而后再生成相应的SOAP应答送回到客户端。2、显现集成服

4、务显现集成服务主假如应用界面集成服务，由服务供给方供给详尽的URL及相关参数说明，调用方传入参数，调用服务方供给的页面进行显现。3、平台Service组件服务平台Service组件服务一致部署在设施保护平台接口服务层上，经过平台接口服务层进行查问操作。2.3接口标准技术标准简述客户端和服务器用SOAP协议经过HTTP来交互，客户端依据WSDL描绘文档生成SOAP恳求信息发送到服务端，服务端分析收到的SOAP恳求，调用Webservice，而后再生成相应的SOAP应答送回到客户端。认证系统设施保护平台供给的全部WebService服务均需要认证受权才能被调用，Webservice服务接收到恳求后

5、从传入参数中获取用户名和密码，进行认证，认证通事后再调用详尽服务。4设施保护平台接口技术规范说明书数据规约简述客户端和服务端采纳XML格式的字符串来交互业务数据，客户端将业务数据组织成XML格式的字符串作为最后一个入参调用服务端接口，服务端分析XML格式的字符串获取业务数据办理业务并把结果组织成XML格式的字符串返回给客户端。接口调用的结果，自动序列化后，以XML格式的字符串返回，此中包含了接口调用中出现的错误描绘。格式商定假如业务接口调用，将以DataItem_Rsp类实例序列化，表示单调数据项，内容包含操作结果、错误描绘，无数据集。假如查问接口调用，将以EntSetSerialize_Rs

6、p类实例序列化，表示查问结果，此中包含错误描绘，有数据集。XML字符串中，假如节点取值为null，则是，在节点中存在属性xsi:nil=true；假如节点取值为空字符串，则是。XML编码格式为“UTF-8”；字段为日期的依据以下商定：年代日格式一致为“YYYY-MM-DD”，如“2006-06-22”。年代格式为“YYYYMM”，如“200606”。包含时间的日期格式一致为“YYYY-MM-DDTHH:MI:SS”，如“2006-06-22T14:00:00”。假如未商定日期格式，则DATE种类的默以为“YYYY-MM-DD”，如“2006-06-22”。格式DTD暂缺5设施保护平台接口技术规

7、范说明书示例示例：查问接口，包含数据集00操作成功331001truee4fb99cf-108b-4688-b124-43ae8a2b5787可控的故障维修900308010ead3b6fb-0c5e-482c-892d-d629f57b75ef900501010900308010101可控的故障维修2011-09-26T17:20:17true195a341c-35dc-43ab-a2fc-b050be12ea0c不行控的故障维修900308020ead3b6fb-0c5e-482c-892d-d629f57b75ef900501010900308020201不行控的故障维修2011-09-

8、26T17:20:32.1876设施保护平台接口技术规范说明书truec648d4d3-9a7e-4f3f-8a2f-96f94cb9d978屡次上下线900308030ead3b6fb-0c5e-482c-892d-d629f57b75ef900501010900308030221屡次上下线2011-11-24T23:28:17.953示例：业务接口，只有返回表记00受权帐号考证失败System.BooleanFalse3Webservice服务3.1设施保护平台供给的服务因为各用户独自安装部署，故关于WebService服务地点，其他独自供给。接口服务清单序服务名称接口名称说明调用方频次号

9、1ClientUserCheck客户端信息考证第三方及时2BaseData_DevList基础数据.设施清单查问第三方及时3BaseData_OrgList基础数据.组织机构及设施分组第三方及时清单查问7设施保护平台接口技术规范说明书4BaseData_DictionaryList基础数据.数据词典代码项查问第三方及时5DevRep_FaultSearch业务流程.故障上报查问第三方半小时6DevRep_FaultReport故障上报第三方半小时7DevRep_RepairSearch业务流程.报修查问第三方半小时8DevRep_RepFeeApp维修报价申请第三方半小时9DevRep_Fau

10、ltRsp维修响应第三方半小时10DevRep_FaultFeedback维修反应第三方半小时11DevRep_RepairAudit维修审查第三方半小时12接口服务设计客户端信息考证服务名称ClientUserCheck接口申明publicDataItem_RspClientUserCheck(stringclientUser,stringclientPwd,stringclientIp)描绘客户端信息考证中文名字段名长度种类非空说明及数据要求入参登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错

11、误；1：无错误ItemType数据项种类ItemValue数据项取值ErrorDesc错误描绘部署状况设施保护平台基础数据，设施清单查问服务名称BaseData_DevList接口申明publicEntSetSerialize_RspBaseData_DevList(string8设施保护平台接口技术规范说明书devType,stringdevIp,stringdevGuid,stringdevCodeSdk,stringdevChannel,stringunitRepGuid,Int32pageIndex,stringclientUser,stringclientPwd,stringclie

12、ntIp)描绘基础数据.设施清单查问中文名字段名长度种类非空说明及数据要求入参设施种类devTypestringN设施IPdevIpstringN设施GUIDdevGuidstringN设施接口编号devCodeSdkstringN来自第三方设施平台设施通道号devChannelstringN维保单位N作为维保方，其登录帐号string所属单位GUID，可作为GUIDunitRepGuid维保单位GUID页索引pageIndexInt32Y登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无

13、错误ErrorDescTotalCountRspCountRspPageSizeRspPageIndexRspPageTotalEntList错误描绘数据查问结果的总记录数实质返回的记录数分页查问的页大小分页查问的页索引分页查问的页总数数据查问结果列表,采纳泛型会合List，自动序列化产生，依据查问接口不同，此中嵌套的对象及其字段名称也不一样，以实质返回结果为准部署状况设施保护平台基础数据，组织机构及设施分组查问服务名称BaseData_OrgList接口申明publicEntSetSerialize_RspBaseData_OrgList(Int329设施保护平台接口技术规范说明书pageI

14、ndex,stringclientUser,stringclientPwd,stringclientIp)描绘基础数据.组织机构及设施分组清单查问中文名字段名长度种类非空说明及数据要求页索引pageIndexInt32Y登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ErrorDescTotalCountRspCountRspPageSizeRspPageIndexRspPageTotalEntList错误描绘数据查问结果的总记录数实质返回的记录数分页查问的页大小分页查问的页索引分页

15、查问的页总数数据查问结果列表,采纳泛型会合List，自动序列化产生，依据查问接口不同，此中嵌套的对象及其字段名称也不一样，以实质返回结果为准部署状况设施保护平台基础数据，数据项查问服务名称BaseData_DictionaryList接口申明publicEntSetSerialize_RspBaseData_DictionaryList(Int32pageIndex,stringnodeCategory,stringnodeType,stringclientUser,stringclientPwd,stringclientIp)描绘基础数据.数据词典代码项查问中文名字段名长度种类非空说明及数据

16、要求页索引pageIndexInt32Y节点大类nodeCategorystringY故障原由大类-900501010故障原由细类-900501020节点细类nodeTypestringN登录帐号clientUserstringY登录密码clientPwdstringY10设施保护平台接口技术规范说明书用户IPclientIpstringY出参IsErrorErrorDescTotalCountRspCountRspPageSizeRspPageIndexRspPageTotalEntList0：有错误；1：无错误错误描绘数据查问结果的总记录数实质返回的记录数分页查问的页大小分页查问的页索引分

17、页查问的页总数数据查问结果列表,采纳泛型会合List，自动序列化产生，依据查问接口不一样，此中嵌套的对象及其字段名称也不一样，以实质返回结果为准部署状况设施保护平台业务流程，故障上报查问服务名称DevRep_FaultSearch接口申明publicEntSetSerialize_RspDevRep_FaultSearch(stringreportUnitGuid,stringfaultAuditStatus,stringdevType,stringfaultType,stringfaultTimeStart,stringfaultTimeEnd,stringrepStatus,stringj

18、obNo,stringdeviceGuid,intpageIndex,stringclientUser,stringclientPwd,stringclientIp)描绘业务流程.故障上报查问中文名字段名长度种类非空入参上报单位stringNGUIDreportUnitGuid故障审查状态faultAuditStatusstringN设施种类devTypestringN故障种类faultTypestringN开始时间faultTimeStartstringN结束时间faultTimeEndstringN维修状态repStatusstringN工单号jobNostringN说明及数据要求作为维保

19、方，其登录帐号所属单位GUID，可作为上报单位GUID故障时间故障时间11设施保护平台接口技术规范说明书设施GUIDdeviceGuidstringN页索引pageIndexInt32Y登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsErrorErrorDescTotalCountRspCountRspPageSizeRspPageIndexRspPageTotalEntList0：有错误；1：无错误错误描绘数据查问结果的总记录数实质返回的记录数分页查问的页大小分页查问的页索引分页查问的页总数数据查问结果列表,采纳

20、泛型会合List，自动序列化产生，依据查问接口不一样，此中嵌套的对象及其字段名称也不一样，以实质返回结果为准部署状况设施保护平台业务流程，故障上报服务名称DevRep_FaultReport接口申明publicDataItem_RspDevRep_FaultReport(stringdeviceGuid,stringfault_Time,stringfault_Type,stringfault_Remark,stringclientUser,stringclientPwd,stringclientIp)描绘故障上报中文名字段名长度种类非空说明及数据要求设施GUIDdeviceGuidstrin

21、gY故障时间fault_TimestringYY故障种类编号，可在数据故障种类fault_Typestring项中查问，参照参数以下节点大类，900501005节点细类，900504050故障描绘fault_RemarkstringY登录帐号clientUserstringY12设施保护平台接口技术规范说明书登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ItemType数据项种类ItemValue数据项取值ErrorDesc错误描绘部署状况设施保护平台业务流程，报修查问服务名称接口申明DevRep_RepairSearch

22、publicEntSetSerialize_RspDevRep_RepairSearch(stringreportUnitGuid,stringrepTransferStatus,stringdevType,stringfaultTypestringfaultTimeStart,stringfaultTimeEnd,stringrepStatus,stringjobNo,stringdeviceGuid,intpageIndex,stringclientUser,stringclientPwd,stringclientIp)描绘业务流程.报修查问中文名字段名长度种类非空入参单位上报string

23、NGUIDreportUnitGuid维修移交状态repTransferStatusstringN设施种类devTypestringN故障种类faultTypestringN开始时间faultTimeStartstringN结束时间faultTimeEndstringN维修状态repStatusstringN工单号jobNostringN设施GUIDdeviceGuidstringN说明及数据要求作为维保方，其登录帐号所属单位GUID，可作为上报单位GUID故障时间故障时间页索引pageIndexInt32Y登录帐号clientUserstringY13设施保护平台接口技术规范说明书登录密码c

24、lientPwdstringY用户IPclientIpstringY出参IsErrorErrorDescTotalCountRspCountRspPageSizeRspPageIndexRspPageTotalEntList0：有错误；1：无错误错误描绘数据查问结果的总记录数实质返回的记录数分页查问的页大小分页查问的页索引分页查问的页总数数据查问结果列表,采纳泛型会合List，自动序列化产生，依据查问接口不一样，此中嵌套的对象及其字段名称也不一样，以实质返回结果为准部署状况设施保护平台业务流程，维修报价申请服务名称接口申明描绘出参DevRep_RepFeeApppublicDataItem_R

25、spDevRep_RepFeeApp(stringfault_Repair_Unit_Guid,stringrepFeeMemo,decimalrepFee,stringclientUser,stringclientPwd,stringclientIp)维修报价申请中文名字段名长度种类非空说明及数据要求维修记录fault_Repair_Unit_GstringYGUIDuid申请描绘repFeeMemostringY申请花费repFeedecimalY登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringYIsError0：有错误

26、；1：无错误ItemTypeItemValueErrorDesc部署状况设施保护平台数据项种类数据项取值错误描绘14设施保护平台接口技术规范说明书业务流程，维修响应服务名称DevRep_FaultRsp接口申明publicDataItem_RspDevRep_FaultRsp(stringfault_Repair_Unit_Guid,stringfault_Reason_Memo,stringclientUser,stringclientPwd,stringclientIp)描绘维修响应中文名字段名长度种类非空说明及数据要求维修记录fault_Repair_Unit_GstringYGUIDu

27、id维修响应说明fault_Reason_MemostringY登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ItemType数据项种类ItemValue数据项取值ErrorDesc错误描绘部署状况设施保护平台0业务流程，维修反应服务名称接口申明描绘DevRep_FaultFeedbackpublicDataItem_RspDevRep_FaultFeedback(stringfault_Repair_Unit_Guid,stringfeedback_Memo,intrepairMinute_DelayAppalystringfault_Reason_Category,stringfault_Reason_TypestringclientUser,stringclientPwd,string