order_management/get_orderstate.php

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

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
Beispielaufruf
- JSON
- CSV

Liefert die Statusmeldungen von Aufträgen zurück.

Beschreibung

GET order_management/get_orderstate.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS

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 Fahrzeuggruppenschlüssel (alle Fahrzeuge einer Gruppe)	string	Entweder vehicle, group oder import Parameter	(ja)
import	RTI Importschlüssel (alle Fahrzeuge)	string	Entweder vehicle, group oder import Parameter	(ja)
customorderid	eigene Auftragsnummer	string	Entweder dieses Feld ist gesetzt, oder start und end	(ja)^*1
start	Datum ab dem alle Auftragsstatus zurückgegeben werden	string	Format: YYYYMMDDHHMMSS	(ja)^*1
end	Datum bis zu dem alle Auftragsstatus zurückgegeben werden	string	Format: YYYYMMDDHHMMSS Die maximale Zeitspanne beträgt 7 Tage.	(ja)^*1
datetype	Art des Datums welches für die Datumseinschränkung genutzt werden soll	string	Mögliche Werte: gps (Standard) insert	nein
format	Ausgabeformat	string	Mögliche Werte: csv (Standard) json	nein

^{*1 Pflicht ist entweder customorderid oder ( start und end )}

Rückgabe

Es wird ein string zurück gegeben. Ansonsten wird bei einem Fehler ein "ERROR:Beschreibung" zurückgegeben.

CSV Format

Das Ergebnis (sofern Auftragsdaten gefunden wurden) ist eine CSV Liste. Die erste Zeile ist Header und enthält die Feldnamen. Als Textbegrenzer wird das Doppelte Hochkomma verwendet.

Metainformationen

Trennzeichen	Komma( , )
Textbegrenzer	Doppeltes Hochkomma ( " )
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1

Spaltenbeschreibung

Spalte	Beschreibung
CUSTORDERID	eigene Auftragsnummer
DATE	Datum der ausgeführten Aktion	DD.MM.YYYY HH:MM:SS
STATE	Beschreibung der Aktion
SOURCETYPE	Auslösertyp der Aktion	PND (für Fahrzeug oder RTI) oder PORTAL
SOURCE	Auslöser der Aktion	Person/System
STATE_IDENT	Kennung des Status (sofern vergeben)
STATE_LANG	Ländercode, falls der Status in einer anderen Sprache am Display gedrückt wurde
STATE_TRANS	Übersetzung des Statustext, falls der Status in einer anderen Sprache am Display gedrückt wurde
META	Meta Info
REQUESTDATE	Anfragezeitpunkt
RTI_IDENT	RTI Ident des Fahrzeuges

Beispiel

"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","STATE_IDENT","STATE_LANG","STATE_TRANS","META","REQUESTDATE","RTI_IDENT"
"Auftrag 123","18.07.2022 09:43:42","Zustellungsversuch","PORTAL","FTL YF 123","","","","","21.07.2022 06:38:50","rti123"

JSON Format

Beispiel

[
   {
       "gpsdate": "18.07.2022 09:43:42",
       "requestdate": "21.07.2022 06:43:45",
       "custom_order_id": "Auftrag 123",
       "state": "Zustellungsversuch",
       "state_trans": null,
       "state_lang": null,
       "state_ident": null,
       "meta": null,
       "source_type": "PORTAL",
       "source": "FTL YF 123",
       "rti_ident": "rti123"
   }
]

Mögliche Fehlerwerte

Fehler	Beschreibung
MISSING_COMPANY	Firmenschlüssel fehlt
INVALID_COMPANY	Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
ERROR_MAINTENANCE	Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
INVALID_KEY(VEHICLE\|GROUP\|IMPORT)	Der gegebene RTI Schlüssel entspricht nicht dem erwarteten Format
NO_KEY_GIVEN(VEHICLE\|GROUP\|IMPORT)	Es wurde kein RTI Schlüssel zur Fahrzeugidentifizierung angegeben.
INVALID_VEHICLE_KEY / INVALID_GROUP_KEY	Es wurden keine Fahrzeuge mit dem angegebenen Schlüssel gefunden.
ERROR_MISSING_CUSTORDERID\|DATEFROM\|DATETO	Sie müssen entweder eine Auftragsnummer oder ein Start- und Enddatum für eine valide Anfrage angeben.
ERROR_INVALID_DATEFROM	Sie haben ein Startdatum angegeben, welches nicht dem erforderlichen Format entspricht.
ERROR_INVALID_DATETO	Sie haben ein Enddatum angegeben, welches nicht dem erforderlichen Format entspricht.
ERROR_INVALID_DATERANGE	Ihr Start- und Enddatum sind entweder mehr als 7 Tage auseinander oder Ihr Enddatum liegt vor Ihrem Startdatum.
ERROR_INVALID_FORMAT	Sie haben ein unbekanntes Ausgabeformat angegeben.
ERROR_INVALID_DATE_TYPE	Sie haben einen unbekannten Datumstyp angegeben.
ERROR_ORDER_NOT_FOUND	Suche über die Auftragsnummer: Es konnte kein Auftrag mit dieser Nummer gefunden werden.
ERROR_DUPLICATE_CUSTOMORDERID	Suche über die Auftragsnummer: Es wurden mehrere Aufträge mit dieser Nummer gefunden. Diese Funktion kann nur für eindeutig identifizierbare Aufträge genutzt werden.

Beispielaufruf

JSON

https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&customorderid=Auftrag 123&format=json

https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=Auftrag 123&format=json

CSV

https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&start=20220501000000&end=20220508000000&format=csv

https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20220501000000&end=20220508000000&format=csv