Wiki-Quellcode von do_order.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 | (% class="box" %) | ||
| 6 | ((( | ||
| 7 | Sie können mit dieser Funktion einfache Serviceaufträge an YellowFox-Tablets senden. Diese enthalten nur ein Ziel und einen Auftragstext. Es können Statusmeldungen zurückgegeben werden. Außerdem kann ein vorher definiertes Formular angehangen werden, das der Fahrer nach Auftragsende ausfüllen und in YellowFox zurücksenden kann. So lassen sich z.B. Lieferscheine abbilden. | ||
| 8 | Es gibt für alle Kunden, die mehr brauchen, unseren Tour Webservice unter [[https:~/~/yfox.li/tour>>https://yfox.li/tour]]. Der Tour Webservice ist ebenfalls bereits in den Abonnements von YellowFox enthalten und steht YellowFox-Kunden nach Freischaltung kostenlos zur Verfügung. Dort sind die Möglichkeiten in Verbindung mit der YellowFleetApp ungleich vielfältiger und alle Funktionen aus den Serviceaufträgen stehen ebenfalls zur Verfügung. Sie können Be- und Entladestellen definieren oder auch YellowFox Workflows nutzen. Mit Workflows können Sie dem Fahrpersonal sehr genau vorgeben, welche Aktion zu welchem Zeitpunkt der Auftragsabarbeitung ausgeführt werden muss. Auch mehrsprachige Statusrückmeldungen sind mit den Workflows von YellowFox möglich. Auch mehrere Sendungen je Adresse sind möglich. Selbst eine Tour mit nur einer Adresse ist viel mächtiger als der weiter oben beschriebene Serviceauftrag. | ||
| 9 | Zum kostenfreien Aktivieren des Tour Webservice oder bei Rückfragen, wenden Sie sich bitte an den YellowFox Support. | ||
| 10 | ))) | ||
| 11 | Erstellt einen Auftrag und sendet diesen an das angegebene Fahrzeug | ||
| 12 | = Beschreibung = | ||
| 13 | **//(% class="blue mark" %)POST(%%) //do_order.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&customorderid**=//NR123XYZ//**&order****text**=//Auftragstext&**lat**=51.0374&**lon**=13.587813// | ||
| 14 | = Parameter = | ||
| 15 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 16 | |company|RTI Firmenschlüssel|string||ja | ||
| 17 | |customorderid|eigene Auftragsnummer|string|max. 20 Zeichen (eigene Auftragsnummer wird nicht auf Duplikate geprüft)|ja | ||
| 18 | |ordertext|Auftragstext|string|max. 500 Zeichen (CE Display, Tablet) | ||
| 19 | max. 200 Zeichen (restliche Displays)|ja | ||
| 20 | |vehicle|RTI Fahrzeugschlüssel|string||ja | ||
| 21 | |lat|Latitude des Navigationsziels|float|-90 bis +90 im Format WGS84|ja bei Garmin Displays | ||
| 22 | |lon|Longitude des Navigationsziels|float|-180 bis +180 im Format WGS84|ja bei Garmin Displays | ||
| 23 | |street|Straßenname des Navigationsziels|string|max. 100 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)|nein | ||
| 24 | |hnr|Hausnummer des Navigationsziels|string|max. 10 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)|nein | ||
| 25 | |zipcode|Postleitzahl des Navigationsziels|string|max. 10 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)|nein | ||
| 26 | |city|Stadt des Navigationsziels|string|max. 100 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)|nein | ||
| 27 | |country|Ländercode des Navigationsziels|string|max. 3 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)|nein | ||
| 28 | |customername1|Kundenname 1|string|max. 100 Zeichen (wird nur auf Fleet V3 angezeigt)|nein | ||
| 29 | |customername2|Kundenname 2|string|max. 100 Zeichen (wird nur auf Fleet V3 angezeigt)|nein | ||
| 30 | |target_time|Vorgabeankunftszeit|datestring|Format: YYYYMMDDHHMM | ||
| 31 | verringert die maximale Anzahl der Zeichen des Auftragstextes um 18 Zeichen|nein | ||
| 32 | |sortnumber|Sortiernummer|int|steht am Anfang des Auftragstextes in eckigen Klammern und | ||
| 33 | verringert die Anzahl der Auftragstextzeichen inkl. 2 Zeichen für die eckigen Klammern|nein | ||
| 34 | |formname|Name des Benutzerdefinierten Formulares, | ||
| 35 | was nach Abschluss des Auftrages angezeigt werden soll|string|max. 20 Zeichen (verfügbar für CE Displays ab Version 1.1.67 und Tablets) | ||
| 36 | (% class="box" %) | ||
| 37 | ((( | ||
| 38 | **Achtung | ||
| 39 | **Das Formular muss vorher dem Fahrzeug als [[Konfiguration >>doc:YellowFox Standard Portal.Verwaltung.Display Konfiguration.Konfiguration benutzerdefinierte Formulare.WebHome]]gesendet worden sein! | ||
| 40 | )))|nein | ||
| 41 | |textlayout|Layout wie der Auftragstext auf dem Display angezeigt wird | ||
| 42 | (hat nur Einfluss auf Garmin FMI Geräte)|int|((( | ||
| 43 | * 0 = [Sortiernummer][Adresstext][Vorgabeankunftszeit]Auftragstext (Standard) | ||
| 44 | * 1 = [Sortiernummer]Auftragstext[Adresstext][Vorgabeankunftszeit] | ||
| 45 | * 2 = [Sortiernummer][Vorgabeankunftszeit][Adresstext]Auftragstext | ||
| 46 | ))) | ||
| 47 | (% class="box" %) | ||
| 48 | ((( | ||
| 49 | **Achtung | ||
| 50 | **Sortiernummer, Auftragstext und Vorgabeankunftszeit werden nur mit eingefügt, falls diese mit übermittelt worden sind | ||
| 51 | )))|nein | ||
| 52 | |save_in_pool|Speichert den Auftrag lediglich im Auftragspool und sendet ihn nicht an ein Fahrzeug|int|0 = wird nicht im Auftragspool gespeichert und erfordert ein Fahrzeug | ||
| 53 | 1 = wird im Auftragspool gespeichert, Fahrzeugschlüssel ist nicht erforderlich, dafür aber der Importschlüssel|nein | ||
| 54 | |meta|Meta Info|string|Wird mit in der get_orders.php wieder ausgegeben um bspw. den Bezug zur eigenern internen ID wieder herstellen zu können|nein | ||
| 55 | |attachments|Dateianhänge|string|UUIDs der gewünschten Dateianhänge, per Komma getrennt | ||
| 56 | Die UUIDs erhalten Sie bei Hochladen der Datei über file_storage/upload_file.php oder per Abruf über file_storage/get_overview.php|nein | ||
| 57 | |||
| 58 | = Rückgabe = | ||
| 59 | Es wird ein **string** zurückgegeben. Bei Erfolg wird als Antwort "**OK**" zurückgegeben. Ansonsten wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben | ||
| 60 | = Beispiele = | ||
| 61 | **Einfacher Auftrag** | ||
| 62 | {{code language="java"}}https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR1234&ordertext=Auftragstext | ||
| 63 | |||
| 64 | https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=NR1234&ordertext=Auftragstext{{/code}} | ||
| 65 | |||
| 66 | **Beispiel mit Navigationsziel und Zielankunftszeit** | ||
| 67 | {{code language="java"}}https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR1234&ordertext=Auftragstext&lat=51.0374&lon=13.587813&street=Hauptstr&hnr=3&zipcode=01723&city=Kesselsdorf&country=D&target_time=201411310800 | ||
| 68 | |||
| 69 | https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=NR1234&ordertext=Auftragstext&lat=51.0374&lon=13.587813&street=Hauptstr&hnr=3&zipcode=01723&city=Kesselsdorf&country=D&target_time=201411310800{{/code}} | ||
| 70 | |||
| 71 | **Beispiel mit Navigationsziel + Formular + Sortiernummer + Textlayout** | ||
| 72 | {{code language="java"}}https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR1234&ordertext=Auftragstext&lat=51.0374&lon=13.587813&street=Hauptstr&hnr=3&zipcode=01723&city=Kesselsdorf&country=D&sortnumber=1&formname=Abholung&textlayout=2 | ||
| 73 | |||
| 74 | https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=NR1234&ordertext=Auftragstext&lat=51.0374&lon=13.587813&street=Hauptstr&hnr=3&zipcode=01723&city=Kesselsdorf&country=D&sortnumber=1&formname=Abholung&textlayout=2{{/code}} | ||
| 75 |