设备维护平台接口技术规范说明书Word文档格式.docx
- 文档编号:18109339
- 上传时间:2022-12-13
- 格式:DOCX
- 页数:27
- 大小:31.10KB
设备维护平台接口技术规范说明书Word文档格式.docx
《设备维护平台接口技术规范说明书Word文档格式.docx》由会员分享,可在线阅读,更多相关《设备维护平台接口技术规范说明书Word文档格式.docx(27页珍藏版)》请在冰豆网上搜索。
1.4参考文献
《智能交通设备维护管理系统设备接入标准》杭州天梦科技有限公司
2接口平台设计
2.1技术架构
2.1.1接口架构图
(暂缺)
2.1.2
业务流图
说明:
用户通过接口。
2.2部署方式
接口服务层包括Webservice服务、展现集成服务。
1、Webservice服务
各系统提供的接口服务统一部署在设备维护平台接口服务层上,各系统客户端和接口服务层用SOAP协议通过HTTP来交互,客户端根据WSDL描述文档生成SOAP请求消息发送到服务端,服务端解析收到的SOAP请求,调用Webservice,然后再生成相应的SOAP应答送回到客户端。
2、展现集成服务
展现集成服务主要是应用界面集成服务,由服务提供方提供详细的URL及相关参数说明,调用方传入参数,调用服务方提供的页面进行展现。
3、平台Service组件服务
平台Service组件服务统一部署在设备维护平台接口服务层上,通过平台接口服务层进行查询操作。
2.3接口标准
2.3.1技术标准
2.3.1.1简述
客户端和服务器用SOAP协议通过HTTP来交互,客户端根据WSDL描述文档生成SOAP请求消息发送到服务端,服务端解析收到的SOAP请求,调用Webservice,然后再生成相应的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,则是<
BANK_CODExsi:
nil="
true"
>
<
/BANK_CODE>
,在节点中存在属性xsi:
;
若是节点取值为空字符串,则是<
BANK_NAME/>
。
XML编码格式为“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示例:
查询接口,包含数据集
?
xmlversion="
1.0"
encoding="
utf-8"
?
EntSetSerialize_RspOfMNG_DATA_DICTIONARYxmlns:
xsi="
http:
//www.w3.org/2001/XMLSchema-instance"
xmlns:
xsd="
//www.w3.org/2001/XMLSchema"
xmlns="
//tempuri.org/"
<
IsError>
0<
/IsError>
ErrorNo>
/ErrorNo>
ErrorDesc>
操作成功<
/ErrorDesc>
TotalCount>
3<
/TotalCount>
RspCount>
/RspCount>
RspPageSize>
10<
/RspPageSize>
RspPageIndex>
/RspPageIndex>
RspPageTotal>
1<
/RspPageTotal>
EntList>
MNG_DATA_DICTIONARY>
IsCreated>
true<
/IsCreated>
NODE_GUID>
e4fb99cf-108b-4688-b124-43ae8a2b5787<
/NODE_GUID>
NODE_NAME>
可控的故障维修<
/NODE_NAME>
NODE_CODE>
900308010<
/NODE_CODE>
NODE_PARENT>
ead3b6fb-0c5e-482c-892d-d629f57b75ef<
/NODE_PARENT>
NODE_VALUE/>
NODE_LEVELxsi:
/>
NODE_CATEGORY>
900501010<
/NODE_CATEGORY>
NODE_TYPE>
/NODE_TYPE>
NODE_SORT>
/NODE_SORT>
ENABLE_STATE>
/ENABLE_STATE>
NODE_MEMO>
/NODE_MEMO>
ADD_TIME>
2011-09-26T17:
20:
17<
/ADD_TIME>
UPDATE_TIMExsi:
/MNG_DATA_DICTIONARY>
195a341c-35dc-43ab-a2fc-b050be12ea0c<
不可控的故障维修<
900308020<
20<
32.187<
c648d4d3-9a7e-4f3f-8a2f-96f94cb9d978<
频繁上下线<
900308030<
22<
2011-11-24T23:
28:
17.953<
/EntList>
/EntSetSerialize_RspOfMNG_DATA_DICTIONARY>
2.3.3.2示例:
业务接口,只有返回标识
DataItem_Rspxmlns:
授权帐号验证失败<
ItemType>
System.Boolean<
/ItemType>
ItemValue>
False<
/ItemValue>
/DataItem_Rsp>
3Webservice服务
3.1设备维护平台提供的服务
由于各用户单独安装部署,故对于WebService服务地址,另外单独提供。
3.1.1接口服务清单
序号
服务名称
接口名称
说明
调用方
频率
1
ClientUserCheck
客户端信息验证
第三方
实时
2
BaseData_DevList
基础数据.设备清单查询
3
BaseData_OrgList
基础数据.组织机构及设备分组清单查询
4
BaseData_DictionaryList
基础数据.数据字典代码项查询
5
DevRep_FaultSearch
业务流程.故障上报查询
半小时
6
DevRep_FaultReport
故障上报
7
DevRep_RepairSearch
业务流程.报修查询
8
DevRep_RepFeeApp
维修报价申请
9
DevRep_FaultRsp
维修响应
10
DevRep_FaultFeedback
维修反馈
11
DevRep_RepairAudit
维修审核
12
3.1.2接口服务设计
3.1.2.1客户端信息验证
接口声明
publicDataItem_RspClientUserCheck(stringclientUser,stringclientPwd,stringclientIp)
描述
中文名
字段名
长度类型
非空
说明及数据要求
入参
登录帐号
clientUser
string
Y
登录密码
clientPwd
用户IP
clientIp
出参
IsError
0:
有错误;
1:
无错误
ItemType
数据项类型
ItemValue
数据项取值
ErrorDesc
错误描述
部署情况
3.1.2.2基础数据,设备清单查询
publicEntSetSerialize_Rsp<
View_DEVICE_PURCHASE>
BaseData_DevList(stringdevType,stringdevIp,stringdevGuid,stringdevCodeSdk,stringdevChannel
stringunitRepGuid,Int32pageIndex,stringclientUser,stringclientPwd,stringclientIp)
设备类型
devType
N
设备IP
devIp
设备GUID
devGuid
设备接口编号
devCodeSdk
来自第三方设备平台
设备通道号
devChannel
维保单位GUID
unitRepGuid
作为维保方,其登录帐号所属单位GUID,可作为维保单位GUID
页索引
pageIndex
Int32
TotalCount
数据查询结果的总记录数
RspCount
实际返回的记录数
RspPageSize
分页查询的页大小
RspPageIndex
分页查询的页索引
RspPageTotal
分页查询的页总数
EntList
数据查询结果列表,采用泛型集合List<
T>
,自动序列化产生,根据查询接口不同,其中嵌套的对象及其字段名称也不同,以实际返回结果为准
3.1.2.3基础数据,组织机构及设备分组查询
BASIC_ORG_DOMAIN>
BaseData_OrgList(Int32pageIndex,stringclientUser,stringclientPwd,stringclientIp)
3.1.2.4基础数据,数据项查询
BaseData_DictionaryList(Int32pageIndex,stringnodeCategory,stringnodeType
stringclientUser,stringclientPwd,stringclientIp)
节点大类
nodeCategory
故障原因大类-900501010
故障原因细类-900501020
节点细类
nodeType
3.1.2.5业务流程,故障上报查询
View_RECORD_FAULT_REPAIR>
DevRep_FaultSearch(stringreportUnitGuid,stringfaultAuditStatus,stringdevType,stringfaultType
stringfaultTimeStart,stringfaultTimeEnd,stringrepStatus,stringjobNo,stringdeviceGuid,intpageIndex
上报单位GUID
reportUnitGuid
作为维保方,其登录帐号所属单位GUID,可作为上报单位GUID
故障审核状态
faultAuditStatus
故障类型
faultType
开始时间
faultTimeStart
故障时间
结束时间
faultTimeEnd
维修状态
repStatus
工单号
jobNo
deviceGuid
3.1.2.6业务流程,故障上报
publicDataItem_RspDevRep_FaultReport(stringdeviceGuid,stringfault_Time,stringfault_Type
stringfault_Remark,stringclientUser,stringclientPwd,stringclientIp)
fault_Time
fault_Type
故障类型编号,可在数据项中查询,参考参数如下
节点大类,900501005
节点细类,900504050
故障描述
fault_Remark
3.1.2.7业务流程,报修查询
View_RECORD_FAULT_REPAIR_UNIT>
DevRep_RepairSearch(stringreportUnitGuid,stringrepTransferStatus,stringdevType,stringfaultType
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 设备 维护 平台 接口 技术规范 说明书
![提示](https://static.bdocx.com/images/bang_tan.gif)