Returns a list of all orders, created during the given timerange.
Description
get_orders.php?company=COMPANY_RTIKEY&vehicleVEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS
Parameters
Parameter | Description | Type | Note | Mandatory |
---|---|---|---|---|
company | RTI company key | string | yes | |
vehicle | RTI vehicle key | string | either vehicle, group or import parameter | (yes) |
group | RTI group key | string | either vehicle, group or import parameter | (yes) |
import | RTI import key | string | either vehicle, group or import parameter | (yes) |
start | start of requested timerange | datestring | format: YYYYMMDDHHMMSS
| yes |
end | end of requested timerange | datestring | format: YYYYMMDDHHMMSS
| yes |
only_ondisplay_created | only return orders, created on a display | int | order creation at display is limited to specific Display types and has to be activated seperately
| no |
Return
Returns a string. Im Fehlerfall wird "ERROR:Beschreibung" zurückgegeben
CSV Format
Bei einer korrekten Anfrage werden die Daten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Dannach folgen dann die Daten
Metainformationen
Trennzeichen | Semikolon ( ; ) |
---|---|
Textbegrenzer | Doppeltes Hochkomma ( " ) |
Zeilenende | 0x0D 0x0A (CarriageReturn LineFeed) |
Header | Zeile 1 |
Kodierung | UTF-8 |
Spalten
Spalte | Beschreibung |
---|---|
DATE | Nachrichtenersrstellungsdatum
|
CUSTORDER | selbst definierte Auftragsnummer |
TEXT | Auftragstext |
VEHICLE | zugeordnetes Fahrzeug |
DELETED_IN_VEHICLE | Auftrag bereits vom Fahrzeugdisplay gelöscht
|
ACTIVE | ist der Auftrag gerade Aktiv
|
LAST_STATE_DATE | Datum der letzten Statusmeldung
|
LAST_STATE_TEXT | die eigentliche letzte Statusmeldung |
NAV_CUSTOMER | Kundenname |
NAV_TEXT | Zieladresse |
NAV_LAT | Geokoordinate der Zieladresse (Latitude) |
NAV_LON | Geokoordinate der Zieladresse (Longitude) |
FORM_NAME | zugeordnetes benutzerdefiniertes Formular |
Beispiel
"DATE";"CUSTORDER";"TEXT";"VEHICLE";"DELETED_IN_VEHICLE";"ACTIVE";"LAST_STATE_DATE";"LAST_STATE_TEXT";"NAV_CUSTOMER";"NAV_TEXT";"NAV_LAT";"NAV_LON"; "2012-12-27 14:39:00";"ORDER1";"TEXT1";"FZG1";"1";"0";"2012-12-27 13:44:44";"Auftrag im Display gelöscht";"";"";"";""; "2012-12-27 13:42:00";"ORDER2";"TEXT2";"FZG1";"0";"1";"2012-12-27 13:28:29";"Start";"";"";"";""; "2012-12-27 12:03:34";"ORDER3";"TEXT3";"FZG2";"1";"0";"2013-01-11 15:57:50";"Erledigt";"YellowFox";"D-01723 Kesselsdorf Am Wüstberg 3";"51.036307";"13.598907"; "2012-12-27 12:03:15";"ORDER4";"TEXT4";"FZG2";"0";"1";"2012-12-27 12:04:03";"Angenommen";"YellowFox";"D-01723 Kesselsdorf Am Wüstberg 3";"51.036307";"13.598907";
Beispielaufrufe
http://map.yellowfox.de/rti/get_orders?company=COMPANY_RTIKEY&VEHICLE=VEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS
http://map.yellowfox.de/rti/get_orders?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&only_ondisplay_created=1
http://map.yellowfox.de/rti/get_orders?company=COMPANY_RTIKEY&group=IMPORT_GROUPKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS