do_track_once.php
Inhaltsverzeichnis
Veranlasst einmalige Ortung für ein Fahrzeug oder eine Gruppe
Beschreibung
GET do_track_once.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&format=xml
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| vehicle | RTI Fahrzeugschlüssel | string | entweder vehicle oder group werden erwartet | (ja) |
| group | RTI Gruppenschlüssel | string | entweder vehicle oder group werden erwartet | (ja) |
| format | Rückgabeformat | string | Format der zurückgelieferten Antwort der Schnittstelleunterstüzte Formate: csv (Standard), xml, json | nein |
Rückgabe
Es wird standardmäßig ein CSV-String zurückgegeben, welcher zu jedem Fahrzeug bei Erfolg OK enthält. Bei einem Fehler wird ein "ERROR:Beschreibung" zurückgegeben
CSV-Format
Metainformationen
| Trennzeichen | Semikolon ( ; ) |
|---|---|
| Textbegrenzer | Doppeltes Hochkomma ( " ) |
| Zeilenende | 0x0D 0x0A (CarriageReturn LineFeed) |
| Header | Zeile 1 |
Spalten
| Spalte | Beschreibung |
|---|---|
| CAR | Vehicle-Name |
| RESULT | Resultat der Aktion |
Beispiel
Rückgabe als CSV
"CAR";"RESULT"
"Car 1";"OK"
"Car 2";"OK"
"Car 3";"ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION"
"Car 4";"ERROR_SEND_ONE_TIME_DETECTION"
XML Format
Rückgabe als XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE yf_dotrackonce SYSTEM "http://map.yellowfox.de/rti/dtd/yf_dotrackonce.dtd">
<yf_dotrackonce>
<tracking>
<car>Car 1</car>
<result>OK</result>
</tracking>
<tracking>
<car>Car 2</car>
<result>OK</result>
</tracking>
<tracking>
<car>Car 3</car>
<result>ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION</result>
</tracking>
<tracking>
<car>Car 4</car>
<result>ERROR_SEND_ONE_TIME_DETECTION</result>
</tracking>
</yf_dotrackonce>
JSON Format (RFC 4627)
Rückgabe als JSON
[{"car":"Car 1","result":"OK"},{"car":"Car 2","result":"OK"},{"car":"Car 3","result":"ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION"},{"car":"Car 4","result":"ERROR_SEND_ONE_TIME_DETECTION"}]
Beispielaufrufe
Einmalige Ortung eines einzelnen Fahrzeuges
https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}
Einmalige Ortung einer Gruppe und gewünschten Rückgabeformat als XML
https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&format=xml