do_order.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
Beispiele

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.
Es gibt für alle Kunden, die mehr brauchen, unseren Tour Webservice unter 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.
Zum kostenfreien Aktivieren des Tour Webservice oder bei Rückfragen, wenden Sie sich bitte an den YellowFox Support.

Erstellt einen Auftrag und sendet diesen an das angegebene Fahrzeug

Beschreibung

POST do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR123XYZ&ordertext=Auftragstext&lat=51.0374&lon=13.587813

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
customorderid	eigene Auftragsnummer	string	max. 20 Zeichen (eigene Auftragsnummer wird nicht auf Duplikate geprüft)	ja
ordertext	Auftragstext	string	max. 500 Zeichen (CE Display, Tablet) max. 200 Zeichen (restliche Displays)	ja
vehicle	RTI Fahrzeugschlüssel	string		ja
lat	Latitude des Navigationsziels	float	-90 bis +90 im Format WGS84	ja bei Garmin Displays
lon	Longitude des Navigationsziels	float	-180 bis +180 im Format WGS84	ja bei Garmin Displays
street	Straßenname des Navigationsziels	string	max. 100 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)	nein
hnr	Hausnummer des Navigationsziels	string	max. 10 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)	nein
zipcode	Postleitzahl des Navigationsziels	string	max. 10 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)	nein
city	Stadt des Navigationsziels	string	max. 100 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)	nein
country	Ländercode des Navigationsziels	string	max. 3 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)	nein
customername1	Kundenname 1	string	max. 100 Zeichen (wird nur auf Fleet V3 angezeigt)	nein
customername2	Kundenname 2	string	max. 100 Zeichen (wird nur auf Fleet V3 angezeigt)	nein
target_time	Vorgabeankunftszeit	datestring	Format: YYYYMMDDHHMM verringert die maximale Anzahl der Zeichen des Auftragstextes um 18 Zeichen	nein
sortnumber	Sortiernummer	int	steht am Anfang des Auftragstextes in eckigen Klammern und verringert die Anzahl der Auftragstextzeichen inkl. 2 Zeichen für die eckigen Klammern	nein
formname	Name des Benutzerdefinierten Formulares, 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) Achtung Das Formular muss vorher dem Fahrzeug als Konfiguration gesendet worden sein!	nein
textlayout	Layout wie der Auftragstext auf dem Display angezeigt wird (hat nur Einfluss auf Garmin FMI Geräte)	int	0 = [Sortiernummer][Adresstext][Vorgabeankunftszeit]Auftragstext (Standard) 1 = [Sortiernummer]Auftragstext[Adresstext][Vorgabeankunftszeit] 2 = [Sortiernummer][Vorgabeankunftszeit][Adresstext]Auftragstext Achtung Sortiernummer, Auftragstext und Vorgabeankunftszeit werden nur mit eingefügt, falls diese mit übermittelt worden sind	nein
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 1 = wird im Auftragspool gespeichert, Fahrzeugschlüssel ist nicht erforderlich, dafür aber der Importschlüssel	nein
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
attachments	Dateianhänge	string	UUIDs der gewünschten Dateianhänge, per Komma getrennt Die UUIDs erhalten Sie bei Hochladen der Datei über file_storage/upload_file.php oder per Abruf über file_storage/get_overview.php	nein

Rückgabe

Es wird ein string zurückgegeben. Bei Erfolg wird als Antwort "OK" zurückgegeben. Ansonsten wird ein "ERROR:Beschreibung" zurückgegeben

Beispiele

Einfacher Auftrag
https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR1234&ordertext=Auftragstext

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

Beispiel mit Navigationsziel und Zielankunftszeit
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

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

Beispiel mit Navigationsziel + Formular + Sortiernummer + Textlayout
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

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