oTMS logo 开放平台
Documentation Help

车辆信息

通过车牌号获取本公司车辆最新位置点信息。

版本号 文档 说明
0.1 当前版本文档

配置说明

oTMS同时在生产环境和测试环境中提供Web Service接口,其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。

注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。

目前对该接口的调用限制为每个公司每秒最多20个请求

接口说明

公共参数

环境 HTTP请求方法 HTTPS请求地址 请求主体MIME类型 响应主体MIME类型
正式环境 POST https://login.otms.cn/ws/openapi/{version}/truck/positions application/json
沙箱环境 POST https://demo.otms.cn/ws/openapi/{version}/truck/positions application/json

请求参数

字段名 位置 是否必填 描述 Schema
login header string
password header string
version path string
body body 车辆信息请求 GpsDataRequest

响应参数

状态码 描述 响应模型
200 successful operation OpenApiResponse

详细描述

GpsDataRequest

字段名 类型 是否必填 描述 示例
trucks array[TruckPositionRequest] 车牌号列表

OpenApiResponse

字段名 类型 是否必填 描述 示例
code string -
msg string -
data object -

TruckPositionRequest

字段名 类型 是否必填 描述 示例
truckPlate string 设备号
from string 轨迹查询开始时间
to string 轨迹查询结束时间

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<truckInfoRequest version="0.1" login="username" password="password">
    <trucks>
        <truckPlate>豫P88888</truckPlate>
    </trucks>
    <trucks>
        <truckPlate>豫1P88888</truckPlate>
    </trucks>
</truckInfoRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<truckInfoResponse version="0.1">
    <code>0</code>
    <msg>success</msg>
    <data>
        <truckPlate>豫P88888</truckPlate>
        <latitude>80.1</latitude>
        <longitude>121.2</longitude>
    </data>
    <data>
        <truckPlate>豫1P88888</truckPlate>
        <code>ESYS240000022</code>
        <msg>没有找到这辆卡车</msg>
    </data>
</truckInfoResponse>

错误码解释

全局反馈代码

反馈代码 说明
0调用成功。

单个请求反馈代码

反馈代码 说明
EAPIE10000027用户名或密码错误。
ESYSE20000010服务器错误。
EAPIE10000031服务器繁忙。
ESYS240000022在该公司名下,没有找到这辆卡车 。
ESYS240000045请求车辆数目超过限制。
EAPIE20000011请求版本号缺失。
EAPIE20000012用户角色错误。
7008无效的请求版本号。

API工具