get_orderstate_v2.asp
Inhaltsverzeichnis
DEPRECATED
Liefert die Statusmeldungen von Aufträgen zurück.
Beschreibung
GET get_orderstate_v2.asp?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&DATEFROM=YYYYMMDD&DATETO=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate
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 Nur über Zeitauswahl | (ja) |
| import | RTI Importschlüssel (alle Fahrzeuge) | string | Entweder vehicle, group oder import Parameter Nur über Zeitauswahl | (ja) |
| CUSTORDERID | eigene Auftragsnummer | string | Entweder dieses Feld ist gesetzt, oder DATEFROM und DATETO | (ja)*1 |
| DATEFROM | Datum ab dem alle Auftragsstatus zurückgegeben werden | string | Format: YYYYMMDD oder DD.MM.YYYY | (ja)*1 |
| DATETO | Datum bis zu dem alle Auftragsstatus zurückgegeben werden | string | Format: YYYYMMDD oder DD.MM.YYYY Die maximale Zeitspanne beträgt 7 Tage. | (ja)*1 |
| timefrom | Präzisierung des Anfangsdatums mit der Zeit | string | Format: HHMMSS | nein |
| timeto | Präzisierung des Enddatums mit der Zeit | string | Format: HHMMSS | nein |
| datetype | "insertdate" gibt alle Einträge zurück welche im abgefragten Zeitraum im Rechenzentrum verarbeitet worden sind | string | nein |
*1 Pflicht ist entweder CUSTORDERID oder ( DATEFROM und DATETO )
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 |
Spalten bei Abfrage über eigene Auftragsnummer
| Spalte | Beschreibung | |
|---|---|---|
| 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/Fahrzeugkennzeichen |
Spalten bei Abfrage über Zeitraum
| 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 |
| REQUESTDATE | Systemzeit der Abfrage | |
| META | Meta Info | |
| RTI_IDENT | RTI Ident des Fahrzeuges | (nur über Importschlüssel oder Gruppenschlüssel Abfrage) |
| 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 |
Mögliche Statustexte
- Zustellungsversuch (YellowFox versucht den Auftrag auf das Display zu senden)
- Zustellung erfolgreich (Der Auftrag ist erfolgreich auf dem Display angekommen)
- Gelesen (Der Auftrag wurde auf dem Display gelesen)
- selbst definierte Auftragsstatus(Auftragsverwaltung-->Einstellungen)
Garminspezifische Rückgaben
- Gelesen - Auftrag Inaktiv
- Aktiv
- Erledigt
- Gelöscht
Beispiel
Rückgabe in CSV
"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","REQUESTDATE","META"
"ORDER1","04.08.2010 09:34:49","Erledigt","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:34:17","Aktiv","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:33:18","Gelesen - Auftrag Inaktiv","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:29:15","Zustellung erfolgreich","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:29:09","Zustellungsversuch","PORTAL","RTI","04.08.2010 09:35:00","META_INFO"
Beispielaufrufe
Abfrage für Auftrag
https://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&CUSTORDERID=123456789
Abfrage für Zeitraum 04.05.2015 00:00:00 - 06.05.2015 23:59:59
https://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&DATEFROM=20150504&DATETO=20150506&timefrom=000000&timeto=235959&datetype=insertdate