Wiki-Quellcode von do_track_once.php
Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | (((Inhaltsverzeichnis))) | ||
| 3 | {{toc/}} | ||
| 4 | |||
| 5 | Veranlasst einmalige Ortung für ein Fahrzeug oder eine Gruppe | ||
| 6 | |||
| 7 | = Beschreibung = | ||
| 8 | //**(% class="green mark" %)GET(%%) do_track_once.php?company**=COMPANY_RTIKEY**&vehicle**=VEHICLE_RTIKEY**&format**=xml | ||
| 9 | // | ||
| 10 | = Parameter = | ||
| 11 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 12 | |company|RTI Firmenschlüssel|string||ja | ||
| 13 | |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group werden erwartet|(ja) | ||
| 14 | |group|RTI Gruppenschlüssel|string|entweder vehicle oder group werden erwartet|(ja) | ||
| 15 | |format|Rückgabeformat|string|Format der zurückgelieferten Antwort der Schnittstelleunterstüzte Formate: csv (Standard), xml, json|nein | ||
| 16 | |||
| 17 | = Rückgabe = | ||
| 18 | Es wird standardmäßig ein **CSV-S****tring** zurückgegeben, welcher zu jedem Fahrzeug bei Erfolg **OK** enthält. Bei einem Fehler wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben | ||
| 19 | == CSV-Format == | ||
| 20 | === Metainformationen === | ||
| 21 | |=Trennzeichen|Semikolon ( ; ) | ||
| 22 | |=Textbegrenzer|Doppeltes Hochkomma ( " ) | ||
| 23 | |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 24 | |=Header|Zeile 1 | ||
| 25 | |||
| 26 | === Spalten === | ||
| 27 | |=Spalte|=Beschreibung | ||
| 28 | |CAR|Vehicle-Name | ||
| 29 | |RESULT|Resultat der Aktion | ||
| 30 | |||
| 31 | === Beispiel === | ||
| 32 | **Rückgabe als CSV** | ||
| 33 | {{code language="java"}}"CAR";"RESULT" | ||
| 34 | "Car 1";"OK" | ||
| 35 | "Car 2";"OK" | ||
| 36 | "Car 3";"ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION" | ||
| 37 | "Car 4";"ERROR_SEND_ONE_TIME_DETECTION"{{/code}} | ||
| 38 | |||
| 39 | == XML Format == | ||
| 40 | **Rückgabe als XML** | ||
| 41 | {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?> | ||
| 42 | <!DOCTYPE yf_dotrackonce SYSTEM "http://map.yellowfox.de/rti/dtd/yf_dotrackonce.dtd"> | ||
| 43 | <yf_dotrackonce> | ||
| 44 | <tracking> | ||
| 45 | <car>Car 1</car> | ||
| 46 | <result>OK</result> | ||
| 47 | </tracking> | ||
| 48 | <tracking> | ||
| 49 | <car>Car 2</car> | ||
| 50 | <result>OK</result> | ||
| 51 | </tracking> | ||
| 52 | <tracking> | ||
| 53 | <car>Car 3</car> | ||
| 54 | <result>ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION</result> | ||
| 55 | </tracking> | ||
| 56 | <tracking> | ||
| 57 | <car>Car 4</car> | ||
| 58 | <result>ERROR_SEND_ONE_TIME_DETECTION</result> | ||
| 59 | </tracking> | ||
| 60 | </yf_dotrackonce>{{/code}} | ||
| 61 | |||
| 62 | == JSON Format (RFC 4627) == | ||
| 63 | **Rückgabe als JSON** | ||
| 64 | {{code language="java"}}[{"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"}]{{/code}} | ||
| 65 | |||
| 66 | = Beispielaufrufe = | ||
| 67 | **Einmalige Ortung eines einzelnen Fahrzeuges** | ||
| 68 | {{code language="java"}}https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY | ||
| 69 | |||
| 70 | https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}} | ||
| 71 | |||
| 72 | **Einmalige Ortung einer Gruppe und gewünschten Rückgabeformat als XML** | ||
| 73 | {{code language="java"}}https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&format=xml{{/code}} | ||
| 74 |