Versions Compared

Old Version 2

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version 3

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Gibt eine Liste aller Aufträge, welche im angegebenem Zeitraum erstellt worden sind

  • company - RTI Firmenkennung
  • vehicle - RTI Fahrzeugkennung
  • group - RTI Gruppenkennung
  • import - RTI Firmenkennung für alle Fahrzeuge
  • start - Datum ab dem alle Aufträge zurückgegeben werden (Format: YYYYMMDDHHMMSS)
  • end - Datum bis zu dem alle Aufträge zurückgegeben werden (Format: YYYYMMDDHHMMSS)
  • only_ondisplay_created - Optional. "0" (es werden alle Aufträge zurück gegeben) oder "1" (es nur Aufträge zurück gegeben, die auf einem Display erstellt worden sind)

Der maximale Abfragezeitraum beträgt 31 Tage.

Beispiel:

Beschreibung

get_orders.php?company=(HEXKEY)&vehicle=(HEXKEY2)COMPANY_RTIKEY&vehicleVEHICLE_RTIKEY&start=20121227000000YYYYMMDDHHMMSS&end=20121228230000

oder

get_orders.php?company=(HEXKEY)&group=(HEXKEY2)&start=20121227000000&end=20121228230000&only_ondisplay_created=1

oder

get_orders.php?company=(HEXKEY)&import=(HEXKEY2)&start=20121227000000&end=20121228230000&only_ondisplay_created=1

 

Rückgabe

Header: "DATE";"CUSTORDER";"TEXT";"VEHICLE";"DELETED_IN_VEHICLE";"ACTIVE";"LAST_STATE_DATE";"LAST_STATE_TEXT";"NAV_CUSTOMER";"NAV_TEXT";"NAV_LAT";"NAV_LON";"FORM_NAME"

...

YYYYMMDDHHMMSS

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring ja
vehicleRTI Fahrzeugschlüsselstringentweder vehicle, group oder import Parameter(ja)
groupRTI Gruppenschlüsselstringentweder vehicle, group oder import Parameter(ja)
importRTI Importschlüsselstringentweder vehicle, group oder import Parameter(ja)
startBeginn des Abfragezeitraumesdatestring

Format: YYYYMMDDHHMMSS

  • der maximale Zeitraum zwischen "start" und "end" beträgt 31 Tage
ja
endEnde des Abfragezeitraumesdatestring

Format: YYYYMMDDHHMMSS

  • der maximale Zeitraum zwischen "start" und "end" beträgt 31 Tage

ja

only_ondisplay_created Optional nur Rückgabe von Aufträgen, die auf dem Display erstellt wurdenint 
  • Gibt alle erstellten Auftrage zurück (Option nicht gesetzt oder "0")
  • Gibt nur die Aufträge zurück, die auf dem Display erstellt wurden (Zuweisung "1")
nein 

Rückgabewerte

Es wird ein string zurückgegeben. 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

...

TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende
0x0D 0x0A (CarriageReturn LineFeed)
Header

...

Zeile 1

Erklärung der Spalten:

...

KodierungUTF-8

Spalten

Spalte
Beschreibung
DATE

Nachrichtenersrstellungsdatum

  • Format: YYYY-MM-DD HH:MM:SS

...

CUSTORDER

...

selbst definierte Auftragsnummer
TEXT

...

Auftragstext
VEHICLE

...

zugeordnetes Fahrzeug
DELETED_IN_

...

VEHICLE 

Auftrag bereits vom Fahrzeugdisplay gelöscht

  • 0 = nein
  • 1 = ja
ACTIVE 

ist der Auftrag gerade Aktiv

  • 0 = nein
  • 1 = ja 

...

LAST_STATE_

...

DATE 

Datum der letzten Statusmeldung

  • Format YYYY-MM-DD HH:MM:

...

  • SS 
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

...

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

Code Block
titleAlle Aufträge, die von und zu einem Fahrzeug gesendet wurden
http://map.yellowfox.de/rti/get_orders?company=COMPANY_RTIKEY&VEHICLE=VEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS
Code Block
titleAlle Aufträge, die auf irgendeinem der Fahrzeuge erstellt wurden
http://map.yellowfox.de/rti/get_orders?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&only_ondisplay_created=1
Code Block
titleAlle Aufträge, die von oder an eine Fahrzeuggruppe gesendet wurden
http://

get_orders.php?company=(HEXKEY)&vehicle=(HEXKEY2)&start=20121227000000&end=20121228230000

oder

get_orders.php?company=(HEXKEY)&group=(HEXKEY2)&start=20121227000000&end=20121228230000&only_ondisplay_created=1

oder

get_orders.php?company=(HEXKEY)&import=(HEXKEY2)&start=20121227000000&end=20121228230000&only_ondisplay_created=1