设备维护平台接口关键技术标准规范说明指导书.doc

设备维护平台接口技术规范说明书（版本号 V1.0）杭州天梦科技二一年五月更改履历版本号修改编号更改时间更改图表和章节更改简明描述更改人同意人V1.0-05-13创建，形成初稿叶庆国V1.1-06-09维修业务操作接口调整，仅开放维保单位相关操作接口叶庆国注：更改人除形成初稿，以后每次修改在未同意确定前均需采取修订方法进行修改。目 录1概述21.1编写目标21.2预期读者21.3参考文件22接口平台设计22.1技术架构22.1.1接口架构图22.1.2业务流图32.2布署方法42.3接口标准42.3.1技术标准42.3.2数据规约52.3.3示例63WEBSERVICE服务73.1设备维护平台提供服务73.1.1接口服务清单73.1.2接口服务设计81 概述1.1 编写目标为设备维护平台信息同时和共享，制订了统一接口规范，用来指导各系统接口设计、开发、联调及迁移工作。范围：本文档关键是对设备维护平台和外围业务系统数据交互需求进行说明。1.2 调试要求强烈要求第三方调用者，先做测试库接口调试，确保接口及参数调用正确，不然将对正式库可能出现系统故障负担关键责任。1.3 预期读者项目组人员、各交互系统包含到开发厂家。1.4 参考文件智能交通设备维护管理系统设备接入标准杭州天梦科技2 接口平台设计2.1 技术架构2.1.1 接口架构图（暂缺）2.1.2 业务流图说明：用户经过接口。2.2 布署方法接口服务层包含Webservice服务、展现集成服务。1、 Webservice服务各系统提供接口服务统一布署在设备维护平台接口服务层上，各系统用户端和接口服务层用SOAP协议经过HTTP来交互，用户端依据WSDL描述文档生成SOAP请求消息发送到服务端，服务端解析收到SOAP请求，调用Web service，然后再生成对应SOAP应答送回到用户端。2、 展现集成服务展现集成服务关键是应用界面集成服务，由服务提供方提供具体URL及相关参数说明，调用方传入参数，调用服务方提供页面进行展现。3、 平台Service组件服务平台Service组件服务统一布署在设备维护平台接口服务层上，经过平台接口服务层进行查询操作。2.3 接口标准2.3.1 技术标准2.3.1.1 简述用户端和服务器用SOAP协议经过HTTP来交互，用户端依据WSDL描述文档生成SOAP请求消息发送到服务端，服务端解析收到SOAP请求，调用Web service，然后再生成对应SOAP应答送回到用户端。2.3.1.2 认证机制设备维护平台提供全部WebService服务均需要认证授权才能被调用，Webservice服务接收到请求后从传入参数中获取用户名和密码，进行认证，认证经过后再调用具体服务。2.3.2 数据规约2.3.2.1 简述用户端和服务端采取XML格式字符串来交互业务数据，用户端将业务数据组织成XML格式字符串作为最终一个入参调用服务端接口，服务端解析XML格式字符串得到业务数据处理业务并把结果组织成XML格式字符串返回给用户端。接口调用结果，自动序列化后，以XML格式字符串返回，其中包含了接口调用中出现错误描述。 2.3.2.2 格式约定若是业务接口调用，将以DataItem_Rsp类实例序列化，表示单一数据项，内容包含操作结果、错误描述，无数据集。若是查询接口调用，将以EntSetSerialize_Rsp类实例序列化，表示查询结果，其中包含错误描述，有数据集。XML字符串中，若是节点取值为null，则是，在节点中存在属性xsi:nil=true；若是节点取值为空字符串，则是。XML编码格式为“UTF-8”；字段为日期遵照以下约定：1. 年月日格式统一为“YYYY-MM-DD”，如“-06-22”。2. 年月格式为“YYYYMM”，如“06”。3. 包含时间日期格式统一为“YYYY-MM-DDTHH:MI:SS”，如“-06-22T14:00:00”。4. 假如未约定日期格式，则DATE类型默认为“YYYY-MM-DD”，如“-06-22”。2.3.2.3 格式DTD暂缺2.3.3 示例2.3.3.1 示例：查询接口，包含数据集 0 0 操作成功 3 3 10 0 1 true e4fb99cf-108b-4688-b124-43ae8a2b5787 可控故障维修 ead3b6fb-0c5e-482c-892d-d629f57b75ef 10 1 可控故障维修 -09-26T17:20:17 true 195a341c-35dc-43ab-a2fc-b050be12ea0c 不可控故障维修 ead3b6fb-0c5e-482c-892d-d629f57b75ef 20 1 不可控故障维修 -09-26T17:20:32.187 true c648d4d3-9a7e-4f3f-8a2f-96f94cb9d978 频繁上下线 ead3b6fb-0c5e-482c-892d-d629f57b75ef 22 1 频繁上下线 -11-24T23:28:17.953 2.3.3.2 示例：业务接口，只有返回标识 0 0 授权帐号验证失败 System.Boolean False 3 Webservice服务3.1 设备维护平台提供服务因为各用户单独安装布署，故对于WebService服务地址，另外单独提供。3.1.1 接口服务清单序号服务名称接口名称说明调用方频率1ClientUserCheck用户端信息验证第三方实时2BaseData_DevList基础数据.设备清单查询第三方实时3BaseData_OrgList基础数据.组织机构及设备分组清单查询第三方实时4BaseData_DictionaryList基础数据.数据字典代码项查询第三方实时5DevRep_FaultSearch业务步骤.故障上报查询第三方半小时6DevRep_FaultReport故障上报第三方半小时7DevRep_RepairSearch业务步骤.报修查询第三方半小时8DevRep_RepFeeApp维修报价申请第三方半小时9DevRep_FaultRsp维修响应第三方半小时10DevRep_FaultFeedback维修反馈第三方半小时11DevRep_RepairAudit维修审核第三方半小时123.1.2 接口服务设计3.1.2.1 用户端信息验证服务名称ClientUserCheck接口申明public DataItem_Rsp ClientUserCheck(string clientUser, string clientPwd, string clientIp)描述用户端信息验证汉字名字段名长度类型非空说明及数据要求入参登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ItemType 数据项类型ItemValue数据项取值ErrorDesc错误描述布署情况设备维护平台3.1.2.2 基础数据，设备清单查询服务名称BaseData_DevList接口申明public EntSetSerialize_Rsp BaseData_DevList(string devType, string devIp, string devGuid, string devCodeSdk, string devChannel, string unitRepGuid, Int32 pageIndex, string clientUser, string clientPwd, string clientIp)描述基础数据.设备清单查询汉字名字段名长度类型非空说明及数据要求入参设备类型devTypestringN设备IPdevIpstringN设备GUIDdevGuidstringN设备接口编号 devCodeSdkstringN来自第三方设备平台设备通道号devChannelstringN维保单位GUIDunitRepGuidstringN作为维保方，其登录帐号所属单位GUID，可作为维保单位GUID页索引pageIndexInt32Y登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ErrorDesc错误描述TotalCount数据查询结果总统计数RspCount实际返回统计数RspPageSize分页查询页大小RspPageIndex分页查询页索引RspPageTotal分页查询页总数EntList数据查询结果列表,采取泛型集合List，自动序列化产生，依据查询接口不一样，其中嵌套对象及其字段名称也不一样，以实际返回结果为准布署情况设备维护平台3.1.2.3 基础数据，组织机构及设备分组查询服务名称BaseData_OrgList接口申明public EntSetSerialize_Rsp BaseData_OrgList(Int32 pageIndex, string clientUser, string clientPwd, string clientIp)描述基础数据.组织机构及设备分组清单查询汉字名字段名长度类型非空说明及数据要求页索引pageIndexInt32Y登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ErrorDesc错误描述TotalCount数据查询结果总统计数RspCount实际返回统计数RspPageSize分页查询页大小RspPageIndex分页查询页索引RspPageTotal分页查询页总数EntList数据查询结果列表,采取泛型集合List，自动序列化产生，依据查询接口不一样，其中嵌套对象及其字段名称也不一样，以实际返回结果为准布署情况设备维护平台3.1.2.4 基础数据，数据项查询服务名称BaseData_DictionaryList接口申明public EntSetSerialize_Rsp BaseData_DictionaryList(Int32 pageIndex, string nodeCategory, string nodeType, string clientUser, string clientPwd, string clientIp)描述基础数据.数据字典代码项查询汉字名字段名长度类型非空说明及数据要求页索引pageIndexInt32Y节点大类nodeCategorystringY故障原因大类-故障原因细类-节点细类nodeTypestringN登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ErrorDesc错误描述TotalCount数据查询结果总统计数RspCount实际返回统计数RspPageSize分页查询页大小RspPageIndex分页查询页索引RspPageTotal分页查询页总数EntList数据查询结果列表,采取泛型集合List，自动序列化产生，依据查询接口不一样，其中嵌套对象及其字段名称也不一样，以实际返回结果为准布署情况设备维护平台3.1.2.5 业务步骤，故障上报查询服务名称DevRep_FaultSearch接口申明public EntSetSerialize_Rsp DevRep_FaultSearch(string reportUnitGuid, string faultAuditStatus, string devType, string faultType, string faultTimeStart, string faultTimeEnd, string repStatus, string jobNo, string deviceGuid, int pageIndex, string clientUser, string clientPwd, string clientIp)描述业务步骤.故障上报查询汉字名字段名长度类型非空说明及数据要求入参上报单位GUIDreportUnitGuidstringN作为维保方，其登录帐号所属单位GUID，可作为上报单位GUID故障审核状态faultAuditStatusstringN设备类型devTypestringN故障类型faultTypestringN开始时间faultTimeStartstringN故障时间结束时间faultTimeEndstringN故障时间维修状态repStatusstringN工单号jobNostringN设备GUIDdeviceGuidstringN页索引pageIndexInt32Y登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ErrorDesc错误描述TotalCount数据查询结果总统计数RspCount实际返回统计数RspPageSize分页查询页大小RspPageIndex分页查询页索引RspPageTotal分页查询页总数EntList数据查询结果列表,采取泛型集合List，自动序列化产生，依据查询接口不一样，其中嵌套对象及其字段名称也不一样，以实际返回结果为准布署情况设备维护平台3.1.2.6 业务步骤，故障上报服务名称DevRep_FaultReport接口申明public DataItem_Rsp DevRep_FaultReport(string deviceGuid, string fault_Time, string fault_Type, string fault_Remark, string clientUser, string clientPwd, string clientIp)描述故障上报汉字名字段名长度类型非空说明及数据要求设备GUIDdeviceGuidstringY故障时间fault_TimestringY故障类型fault_TypestringY故障类型编号，可在数据项中查询，参考参数以下节点大类，节点细类，故障描述fault_RemarkstringY登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ItemType 数据项类型ItemValue数据项取值ErrorDesc错误描述布署情况设备维护平台3.1.2.7 业务步骤，报修查询服务名称DevRep_RepairSearch接口申明public EntSetSerialize_Rsp DevRep_RepairSearch(string reportUnitGuid, string repTransferStatus, string devType, string faultType , string faultTimeStart, string faultTimeEnd, string repStatus, string jobNo, string deviceGuid, int pageIndex , string clientUser, string clientPwd, string clientIp)描述业务步骤.报修查询汉字名字段名长度类型非空说明及数据要求入参上报单位GUIDreportUnitGuidstringN作为维保方，其登录帐号所属单位GUID，可作为上报单位GUID维修移交状态repTransferStatusstringN设备类型devTypestringN故障类型faultTypestringN开始时间faultTimeStartstringN故障时间结束时间faultTimeEndstringN故障时间维修状态repStatusstringN工单号jobNostringN设备GUIDdeviceGuidstringN页索引pageIndexInt32Y登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ErrorDesc错误描述TotalCount数据查询结果总统计数RspCount实际返回统计数RspPageSize分页查询页大小RspPageIndex分页查询页索引RspPageTotal分页查询页总数EntList数据查询结果列表,采取泛型集合List，自动序列化产生，依据查询接口不一样，其中嵌套对象及其字段名称也不一样，以实际返回结果为准布署情况设备维护平台3.1.2.8 业务步骤，维修报价申请服务名称DevRep_RepFeeApp接口申明public DataItem_Rsp DevRep_RepFeeApp(string fault_Repair_Unit_Guid, string repFeeMemo, decimal repFee, string clientUser, string clientPwd, string clientIp)描述维修报价申请汉字名字段名长度类型非空说明及数据要求维修统计GUIDfault_Repair_Unit_GuidstringY申请描述repFeeMemostringY申请费用repFeedecimalY登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ItemType 数据项类型ItemValue数据项取值ErrorDesc错误描述布署情况设备维护平台3.1.2.9 业务步骤，维修响应服务名称DevRep_FaultRsp接口申明public DataItem_Rsp DevRep_FaultRsp(string fault_Repair_Unit_Guid, string fault_Reason_Memo, string clientUser, string clientPwd, string clientIp)描述维修响应汉字名字段名长度类型非空说明及数据要求维修统计GUIDfault_Repair_Unit_GuidstringY维修响应说明fault_Reason_MemostringY登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ItemType 数据项类型ItemValue数据项取值ErrorDesc错误描述布署情况设备维护平台3.1.2.10 业务步骤，维修反馈服务名称DevRep_FaultFeedback接口申明public DataItem_Rsp DevRep_FaultFeedback(string fault_Repair_Unit_Guid, string feedback_Memo, int repairMinute_DelayAppaly, string fault_Reason_Category, string fault_Reason_Type, string clientUser, string clientPwd, string clientIp)描述维修反馈汉字名字段名长度类型非空说明及数据要求维修统计GUIDfault_Repair_Unit_GuidstringY维修反馈说明feedback_MemostringY维修延迟时长repairMinute_DelayAppalyInt32Y单位：分钟故障原因大类fault_Reason_CategorystringY故障类型编号，可在数据项中查询故障原因细类fault_Reason_TypestringY故障类型编号，可在数据项中查询登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ItemType 数据项类型ItemValue数据项取值ErrorDesc错误描述布署情况设备维护平台3.1.2.11 业务步骤，维修审核服务名称DevRep_RepairAudit接口申明public DataItem_Rsp DevRep_RepairAudit(string fault_Repair_Unit_Guid, bool isAudit, string repairAuditMemo, int repairMinute_DelayAppaly, string clientUser, string clientPwd, string clientIp)描述维修审核汉字名字段名长度类型非空说明及数据要求维修统计GUIDfault_Repair_Unit_GuidstringY审核结果isAuditboolYTrue-维修审核经过False-维修返工，重新反馈维修审核说明repairAuditMemostringY维修延迟时长repairMinute_DelayAppalyInt32Y单位：分钟登录帐号clientUserstringY登录密码clientPwdstringY用户IPclientIpstringY出参IsError0：有错误；1：无错误ItemType 数据项类型ItemValue数据项取值ErrorDesc错误描述布署情况设备维护平台