get_orders.php

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

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
- CSV Format
Beispielaufrufe

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

Beschreibung

GET get_orders.php?company=COMPANY_RTIKEY&vehicleVEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&format=json

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
vehicle	RTI Fahrzeugschlüssel	string	entweder vehicle, group oder import Parameter	(ja)
group	RTI Gruppenschlüssel	string	entweder vehicle, group oder import Parameter	(ja)
import	RTI Importschlüssel	string	entweder vehicle, group oder import Parameter	(ja)
start	Beginn des Abfragezeitraumes	datestring	Format: YYYYMMDDHHMMSS der maximale Zeitraum zwischen "start" und "end" beträgt 31 Tage	ja
end	Ende des Abfragezeitraumes	datestring	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 wurden	int	Die Auftragserstellung ist nicht für alle Displaytypen verfügbar und muss jeweils freigeschalten werden 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
format	Ausgabeformat	string	'csv' (Standard) oder 'json'	nein

Rückgabe

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

Trennzeichen	Semikolon ( ; )
Textbegrenzer	Doppeltes Hochkomma ( " )
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1
Kodierung	UTF-8

Spalten

Spalte	Beschreibung
DATE	Auftragserstellungsdatum	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
LAST_STATE_IDENT	Kennung des Status (sofern vergeben)
LAST_STATE_LANG	Ländercode, falls der Status in einer anderen Sprache am Display gedrückt wurde
LAST_STATE_TRANS	Übersetzung des Statustext, falls der Status in einer anderen Sprache am Display gedrückt wurde
NAV_CUSTOMER	Kundenname
NAV_TEXT	Zieladresse
NAV_LAT	Geokoordinate der Zieladresse (Latitude)
NAV_LON	Geokoordinate der Zieladresse (Longitude)
FORM_NAME	zugeordnetes benutzerdefiniertes Formular
META	Meta Info
RTI_IDENT	RTI Ident des Fahrzeuges

JSON Format

[
    {
       "create_date": "2022-03-15 09:43:30",
       "custom_order_number": "ExampleNr",
       "text": "Beispieltext",
       "vehicle": {
           "name": "YT 120",
           "rtiIdent": "YT 120 Ident"
        },
       "is_deleted": false,
       "is_active": true,
       "last_state": {
           "date": "2022-03-15 09:45:44",
           "text": "start",
           "custom_id": "",
           "language": "",
           "translations": ""
        },
       "target_information": {
           "customer": "Nico@home",
           "address": "Am Wuesteberg 3, 01723 Kesselsdorf, D",
           "lat": 51.0096,
           "lon": 13.8376,
           "arrival_time_planned": "2022-03-15 16:00:00"
        },
       "form": {
           "name": "Fotos"
        },
       "meta": ""
    }
]

Beispiel

Rückgabe in CSV
"DATE";"CUSTORDER";"TEXT";"VEHICLE";"DELETED_IN_VEHICLE";"ACTIVE";"LAST_STATE_DATE";"LAST_STATE_TEXT";"NAV_CUSTOMER";"NAV_TEXT";"NAV_LAT";"NAV_LON";"META";"RTI_IDENT"
"2012-12-27 14:39:00";"ORDER1";"TEXT1";"FZG1";"1";"0";"2012-12-27 13:44:44";"Auftrag im Display gelöscht";"";"";"";"";"";"Ident 1"
"2012-12-27 13:42:00";"ORDER2";"TEXT2";"FZG1";"0";"1";"2012-12-27 13:28:29";"Start";"";"";"";"";"";"Ident 1"
"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";"";"Ident 1"
"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";"";"Ident 1"

Beispielaufrufe

Alle Aufträge, die von und zu einem Fahrzeug gesendet wurden
https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&VEHICLE=VEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS

https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&VEHICLE={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS

Alle Aufträge, die auf irgendeinem der Fahrzeuge erstellt wurden
https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&only_ondisplay_created=1

Alle Aufträge, die von oder an eine Fahrzeuggruppe gesendet wurden
https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&group=IMPORT_GROUPKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS