Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede


Info

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, dass 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 Tourservice unter https://yfox.li/tour. Der Tourservice 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 Tourservice oder bei Rückfragen, wenden Sie sich bitte an den YellowFox Support.

Erstellt einen Auftrag und sendet diesen an das angegebene Fahrzeug

Beschreibung

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

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring
ja
customorderideigene Auftragsnummerstringmax. 20 Zeichen (eigene Auftragsnummer wird nicht auf Duplikate geprüft)

ja

ordertextAuftragstextstring

max. 500 Zeichen (CE Display, Tablet)

max. 200 Zeichen (restliche Displays)

ja
vehicleRTI Fahrzeugschlüsselstring
ja
latLatitude des Navigationszielsfloat-90 bis +90 im Format WGS84ja bei Garmin Displays
lonLongitude des Navigationszielsfloat-180 bis +180 im Format WGS84ja bei Garmin Displays
streetStraßenname des Navigationszielsstringmax. 100 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)nein
hnrHausnummer des Navigationszielsstringmax. 10 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)nein
zipcodePostleitzahl des Navigationszielsstringmax. 10 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)nein
cityStadt des Navigationszielsstringmax. 100 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)nein
countryLändercode des Navigationszielsstringmax. 3 Zeichen (verringert die Anzahl der möglichen Zeichen des Auftragstextes bei Garmin Displays)nein
customername1Kundenname 1stringmax. 100 Zeichen (wird nur auf Fleet V3 angezeigt)nein
customername2Kundenname 2stringmax. 100 Zeichen (wird nur auf Fleet V3 angezeigt)nein
target_timeVorgabeankunftszeitdatestring

Format: YYYYMMDDHHMM

verringert die maximale Anzahl der Zeichen des Auftragstextes um 18 Zeichen

nein
sortnumberSortiernummerint

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)

Info
titleAchtung

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
Info
titleAchtung

Sortiernummer, Auftragstext und Vorgabeankunftszeit werden nur mit eingefügt, falls diese mit übermittelt worden sind


nein
save_in_poolSpeichert den Auftrag lediglich im Auftragspool und sendet ihn nicht an ein Fahrzeugint

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
metaMeta InfostringWird mit in der get_orders.php wieder ausgegeben um bspw. den Bezug zur eigenern internen ID wieder herstellen zu könnennein
attachmentsDateianhängestring

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

Code Block
titleEinfacher 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


Code Block
titleBeispiel 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


Code Block
titleBeispiel 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


Sv translation
languageen


Info

You can use this function to send simple service orders to YellowFox tablets. These contain only one destination and an order text. The order can return status messages and you are able to attach a form, which the driver has to fill-out after executing the order. You can e.g. use this to model delivery notes.

All customers who need more than this can use the Tour Webservice, located at https://yfox.li/tour. The Tour Webservice is already included in the YellowFox subscription and can be used for free after activation. Beside all functions that are supported by orders, tours offer a lot more. You are able to define multiple pick-up and delivery stations or use YellowFox workflows. By using workflows you can define precisely what the driver has to do in which order. Multi-langual status messages are also possible, as well as multiple shipments for a single address. Even by building a tour with just one destination it will still be much more  powerful than a simple order.

To unlock to Tour Webservice for free or get further information and help, please contact the YellowFox support. 

Creates an Ceates a order and sends it to the vehicle.

Description

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

Parameter

ParameterDescriptionTypeNoteMandatory
companyRTI company keystring
yes
customorderidown user-defined order numberstringmax. 20 chars (will not be checked for duplicates)

yes

ordertextorder textstring

max. 500 chars (CE Display, Tablet)

max. 200 chars (all other displays)

yes
vehicleRTI vehicle keystring
yes
latLatitude of navigation targetfloat-90 to +90 in WGS84 format yes for Garmin displays
lonLongitude of navigation targetfloat-180 to +180 in WGS84 format yes for Garmin displays
streetstreet name of navigation targetstringmax. 100 chars (reduces the max char count of order text for garmin displays)no
hnrhouse number of navigation targetstringmax. 10 chars (reduces the max char count of order text for garmin displays)no
zipcodezipcode of navigation targetstringmax. 10 chars (reduces the max char count of order text for garmin displays)no
citycity of navigation targetstringmax. 100 chars (reduces the max char count of order text for garmin displays)no
countrycountry code of navigation targetstringmax. 3 chars (reduces the max char count of order text for garmin displays)no
customername1Customer Name 1stringmax. 100 chars (will be displayed only on Fleet V3)no
customername2Customer Name 2stringmax. 100 chars (will be displayed only on Fleet V3)no
target_timetarget arrival timedatestring

Format: YYYYMMDDHHMM

reduces maximum char count of order text down by 18 chars

no
sortnumbersort numberint

Will be written in front of the order text in brackets. Reduces the max char count of order text + 2 chars.

no
formname

name of customer formular form which will be opened after conclusion of the order has been executed

string

max. 20 chars (available for CE Displays at Version 1.1.67 and Tablets)

Info
titleAttention

Form must be configured!


no
textlayout

layout of order text at display

(only available for Garmin FMI displays)

int
  • 0 = [sort number][addresstext][target time]order text (default)
  • 1 = [sort number]order text[addresstext][target time ] (only for Garmin FMI displays)
  • 2 = [sort number][target time][addresstext]order text(only for Garmin FMI displays)
Info
titleAttention

sort number, order text and target time must be given if these values should be transmitted


no
save_in_poolSaves the order only in the order pool and does not send it to a vehicle.int

0 = is not stored in the order pool and requires a vehicle

1 = is stored in the order pool, vehicle key is not required, but the import key is

no
metameta infostringThis info will be returned on accessing the order via get_orders.php to be able to track this order.no
attachmentsfile attachmentsstring

UUIDs of desired file attachments, comma-separated

You get these UUIDs while uploading a file via file_storage/upload_file.php or you can access them via file_storage/get_overview.php

no

Return

A string string will be returned. If the request was successful "OK". If the request failed "ERROR:Description".

Example calls

Code Block
titleSimple order
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


Code Block
titleExample with navigation target and target time
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


Code Block
titleExample with navigation target + form + sort number + 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