说明:
TVSS 企业端应用,如:企业内部ERP,办公自动化等,作为WebService接口的客户端
GPS GPS监控平台,作为WebService接口的服务端
一、接口报文标准
1.1 报文整体标准
1.1.1 报文文件格式
文件格式包括XML声明,必须在最开始声明如下所示:
<?xml version="1.0" encoding="GBK"?>
1.1.2
报文整体结构
XML块采用层次化结构数据块作为请求与响应的数据文件内容,数据块如下所示:
<?xml version="1.0"
encoding="GBK"?>
<tvss>
<head>
消息头……
</head>
<body>
消息体……
<body>
</tvss>
1.1.3
标签命名规范
采用camelCase命名法,即第一个单词小写,此后每个单词的首字母大写。如:accessCode。
XML
元素都须有关闭标签,标签对大小写敏感。
1.1.4 标签内容规范
在 XML 中,有 5 个预定义的实体引用:
< | < | 小于 |
> | > | 大于 |
& | & | 和号 |
&apos | ' | 单引号 |
" | " | 双引号 |
(注意:XML 中,只有字符 "<" 和 "&" 确实是非法的。大于号是合法的,但是用实体引用来代替它是一个好习惯,TVSS要求用实体引用来代替。)
1.2 接入报文标准
1.2.1 请求报文
1.2.1.1 请求报文头(reqHead)
标记(Tag) | 说明 | 可空 | 格式 | 出现次数 |
---|---|---|---|---|
<head> | 报文头开始 | 1 | ||
<accessCode> | 接入代码 | 否 | 字符1-20位 | 1 |
<identify> | 标识符 | 否 | 字符0-32位 | 1 |
<businessType> | 业务类型: | 否 | 字符1-20位 | 1 |
</head> | 报文头结束 |
1.2.1.2 请求报文体(reqBody)
标记(Tag) | 说明 | 可空 | 格式 | 出现次数 |
---|---|---|---|---|
<body> | 报文体开始 | 1 | ||
<reqMsg> | 请求报文体开始 | 1 | ||
…… | 请求报文体具体内容 | |||
</reqMsg> | 请求报文体结束 | |||
</body> | 报文体结束 |
1.2.2 响应报文
1.2.2.1 响应报文头(respHead)
标记(Tag) | 说明 | 可空 | 格式 | 出现次数 |
---|---|---|---|---|
<head> | 报文头开始 | 1 | ||
<accessCode> | 接入代码 | 否 | 字符1-20位 | 1 |
<businessType> | 业务类型 | 否 | 字符1-20位 | 1 |
<respCode> | 返回代码 | 否 | 字符固定4位 | 1 |
<respDesc> | 返回描述 | 否 | 字符1-128位 | 1 |
</head> | 报文头结束 |
1.2.2.2 响应报文体(respBody)
标记(Tag) | 说明 | 可空 | 格式 | 出现次数 |
---|---|---|---|---|
<body> | 报文体开始 | 1 | ||
<respMsg> | 响应报文体开始 | 1 | ||
…… | 响应报文体具体内容 | |||
</respMsg> | 响应报文体结束 | |||
</body> | 报文体结束 |
二、接入业务类型报文
2.1 GPS报文
2.1.1 GPS服务端报文(TVSS --->
GPS)
业务类型businessType:GPS_CONTROLSENDMSG
2.1.1.1 处理流程
职责划分如下:
客户端(请求服务端Web Service) | 服务端(提供Web Service) |
---|---|
TVSS | Carrier GPS |
正常处理步骤说明如下:
a. TVSS将运作中的车牌号(或车牌号列表),请求Carrier GPS提供的Web
Service发送给GPS服务端,开启GPS定位信息跟踪;
b. TVSS将运作完成的车牌号(或车牌号列表),请求Carrier GPS供应商提供的Web
Service发送给GPS服务端,关闭GPS定位信息跟踪;
c. 车牌号(或车牌号列表)开启和关闭定位信息可以放在同一个报文中;
异常处理步骤说明如下:
a. TVSS接收到Carrier
GPS响应信息中响应代码非“0000”(响应代码请参见附录1);
b.
TVSS会对响应消息进行分析处理后,再次请求Carrier GPS提供的Web
Service将重新发送车牌号(或车牌号列表)进行开启和关闭,直到成功处理完成。
2.1.1.2 报文
2.1.1.2.1 请求报文
2.1.1.2.1.1 reqMsg标签定义
标记(Tag) | 说明 | 可空 | 格式 | 次数 |
---|---|---|---|---|
<car seq="…"> | 数据项开始 | 1或多次 | ||
<controlType> | controlType控制GPS发送数据或停止发:开始发送数据、停止发送数据 | 否 | 文本 [1,1] | 1 |
<carNo> | 车牌号 | 否 | 文本 [1,1] | 1 |
</car> | 数据项结束 |
(注意:为了减少网络传输等待时间,一次请求报文中car最大seq为1000,多出部分请拆成多个包分批发送。)
系统处理逻辑:
运作中的车辆controlType为1;运作完成的车辆controlType为2。
数据校验逻辑:
由Carrier GPS自己处理,处理逻辑请以文档描述形式告知TVSS。