Versions Compared

Key

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

...

Sv translation
languageen

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

ParameterDescriptionTypeNoteMandatory
companyRTI company keystring yes
vehicleRTI vehicle keystringeither vehicle, group or import parameter(yes)
groupRTI group keystringeither vehicle, group or import parameter(yes)
importRTI import keystringeither vehicle, group or import parameter(yes)
startstart of requested timerangedatestring

format: YYYYMMDDHHMMSS

  • the timerange between "start" and "end" is limited to 31 days
yes
endend of requested timerangedatestring

format: YYYYMMDDHHMMSS

  • the timerange between "start" and "end" is limited to 31 days

yes

only_ondisplay_created only return orders, created on a displayint 

order creation at display is limited to specific Display types and has to be activated seperately

  • not set or value "0": Returns all created orders
  • value "1": Returns only orders created on a display 
no 

Return

Returns a string. Im Fehlerfall wird  In case of error it returns "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

The result of a correct request will be a csv (comma seperated values) formatted file containing always a head with column names as first line. The following lines containing the single entries.

Meta informations

SeparatorSemicolon ( ; )
DelimiterDouble quote ( " )
Line break
TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1Line 1
KodierungEncodingUTF-8
Spalten

Columns

SpalteColumn
BeschreibungDescription
DATE

date when order was created

  • format

Nachrichtenersrstellungsdatum

  • Format: YYYY-MM-DD HH:MM:SS
CUSTORDERselbst definierte Auftragsnummerself defined order number
TEXTAuftragstextorder text
VEHICLEzugeordnetes Fahrzeugassigned vehicle
DELETED_IN_VEHICLE 

Auftrag bereits vom Fahrzeugdisplay gelöschtindicate, if order deleted on vehicle display

  • 0 = nein no
  • 1 = jayes
ACTIVE 

ist der Auftrag gerade Aktivindicate, if order is currently active

  • 0 = neinno
  • 1 = ja yes
LAST_STATE_DATE 

Date of latest state change

  • format

Datum der letzten Statusmeldung

  • Format YYYY-MM-DD HH:MM:SS 
LAST_STATE_TEXT die eigentliche letzte Statusmeldung the state description
NAV_CUSTOMER 

Kundenname customer name

NAV_TEXT Zieladresse target adress
NAV_LAT Geokoordinate der Zieladresse geocoordinate for target adress (Latitude)
NAV_LON Geokoordinate der Zieladresse geocoordinate for target adress (Longitude) 
FORM_NAME zugeordnetes benutzerdefiniertes Formular 
Beispiel
assigned user defined form

Example

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

Example calls

Code Block
titleAlle Aufträge, die von und zu einem Fahrzeug gesendet wurdenAll orders sent by or to a vehicle
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 wurdenAll orders created on any vehicle
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 wurdenAll orders sent or created on any vehicle of the vehicle group
http://map.yellowfox.de/rti/get_orders?company=COMPANY_RTIKEY&group=IMPORT_GROUPKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS