六合一综合平台外挂系统接口使用手册.doc
- 格式:doc
- 大小:455.05 KB
- 文档页数:10
交通管理综合应用平台外挂系统请求服务
接口使用手册
目录
第一部分接口调用规范 . ............................................................. 1.1.接口访问地址................................................................
1.2.接口调用函数................................................................
查询类接口................................................................
写入类接口................................................................
1.3.XML 文件格式定义 . ...........................................................
查询类接口XML文档 ........................................................
写入类接口XML文档 ........................................................
1.4.调用注意事项................................................................
XML文档的中文处理.........................................................
返回结果错误代码说明...................................................... 第二部分外挂系统接口说明. .........................................................
1.接口说明 ....................................................................
2.接口列表 ....................................................................
2.1.机动车接口定义. ..............................................................
第一部分接口调用规范
1.1. 接口访问地址
外挂系统请求服务的接口访问地址:
trffweb/services/TmriOutAccess?wsdl
其中 IP 标识 Web服务器地址; port 对应系统应用服务的端口号,启用 80 的不填写。
1.2. 接口调用函数
外挂系统请求服务平台的接口包括两类:查询类和写入类接口。查询类接口对外提供查询服务,写入类接口对外提供将业务
数据写入综合应用平台业务库。
1.2.1. 查询类接口
public StringqueryObjectOut(Stringxtlb,String jkxlh,String jkid,String QueryXmlDoc);
表 1:查询类接口调用参数说明序号参数名称参数说明备注信息
xtlb 系统类别接口提供者的业务类别代码,
1 如机动车登记业务: 01,驾驶证管理业务: 02,事
故处理: 03,违法处理: 04,交警队平台: 05,剧
毒品业务: 06
2 jkxlh 接口序列号由外挂系统请求服务平台授权生成下发
jkid 接口标识 5 位,由系统类别+一位级别代码+两位接口顺序
3 号组成 (参照监管系统 ),C:支队、 B: 总队, A :部局。如 01A01 代表机动车部局端提供的接口。定义时查询类接口顺序号取 50 以内的数字,写入接口
顺序号定义为 50 以上的数字。
4 QueryXmlDoc 查询条件封装查询条件的 XML 格式文档
1.2.2. 写入类接口
Public String writeObjectOut (String xtlb,String jkxlh,String jkid;String WriteXmlDoc)
表 2 写入类接口调用参数说明
序号参数名称参数说明备注信息
1 xtlb 系统类别同上
2 jkxlh 接口序列号同上
3 jkid 接口标识同上
4 WriteXmlDoc 写入数据业务数据写入 XML 格式文档
1.3. XML 文件格式定义
1.3.1. 查询类接口 XML文档
查询条件 QueryXmlDoc 的文档格式要求如下:
查询返回结果XML文档格式
1.3.
2. 写入类接口 XML文档
写入数据 WriteXmlDoc 文档格式如下:
写入操作返回结果文档格式如下:
1.4. 调用注意事项
1.4.1. XML文档的中文处理
(1)接口查询结果进行过 URLDecoder和 UTF-8 编码处理 , 须进行转换(转换函数为 URLDecoder.decode(str, "utf-8"); )才能正常读取;
(2)写入信息中文字符必须 URLEncoder 成 utf-8 格式(转
换函数为URLEncoder.encode(xmlDoc, "utf-8");)后再封装成XML文档。
(3) XML文档的【写入数据字段】和【返回结果字段】的标
签均为小写字符。XML 文档【节点标签】必须和手册中注明的
保持一致。
1.4.
2. 返回结果错误代码说明
正常返回结果 code 为成功与否标记( 0、失败; 1、成功或其他,由提供的接口服务定义),网络异常或接口权限异常等系统原因时返回 $E 的标记。写入失败时的 message返回详细描述信息。