Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Status
colourRed
titleDEPRECATED

Liefert die Statusmeldungen von Aufträgen zurück.

Beschreibung

Status
colourGreen
titleGET
 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
companyRTI Firmenschlüsselstring
ja
vehicleRTI FahrzeugschlüsselstringEntweder vehicle, group oder import Parameter(ja)
group

RTI Fahrzeuggruppenschlüssel (alle Fahrzeuge einer Gruppe)

stringEntweder vehicle, group oder import Parameter
Nur über Zeitauswahl
(ja)
import

RTI Importschlüssel (alle Fahrzeuge)

stringEntweder vehicle, group oder import Parameter
Nur über Zeitauswahl
(ja)
CUSTORDERIDeigene AuftragsnummerstringEntweder dieses Feld ist gesetzt, oder DATEFROM und DATETO(ja)*1
DATEFROMDatum ab dem alle Auftragsstatus zurückgegeben werdenstringFormat: YYYYMMDD oder DD.MM.YYYY(ja)*1
DATETODatum bis zu dem alle Auftragsstatus zurückgegeben werdenstringFormat: YYYYMMDD oder DD.MM.YYYY
Die maximale Zeitspanne beträgt 7 Tage.
(ja)*1
timefromPräzisierung des Anfangsdatums mit der ZeitstringFormat: HHMMSSnein
timetoPräzisierung des Enddatums mit der ZeitstringFormat: HHMMSSnein
datetype"insertdate" gibt alle Einträge zurück welche im abgefragten Zeitraum im Rechenzentrum verarbeitet worden sindstring
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

TrennzeichenKomma( , )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1

Spalten bei Abfrage über eigene Auftragsnummer

Spalte
Beschreibung

DATEDatum der ausgeführten AktionDD.MM.YYYY HH:MM:SS
STATEBeschreibung der Aktion
SOURCETYPEAuslösertyp der AktionPND für Fahrzeug oder RTI oder PORTAL
SOURCEAuslöser der AktionPerson/Fahrzeugkennzeichen

Spalten bei Abfrage über Zeitraum

Spalte
Beschreibung

CUSTORDERIDeigene Auftragsnummer
DATEDatum der ausgeführten AktionDD.MM.YYYY HH:MM:SS
STATEBeschreibung der Aktion
SOURCETYPEAuslösertyp der AktionPND für Fahrzeug oder RTI oder PORTAL
SOURCEAuslöser der AktionPerson/System
REQUESTDATESystemzeit der Abfrage
METAMeta Info
RTI_IDENT
RTI Ident des Fahrzeuges(nur über Importschlüssel oder Gruppenschlüssel Abfrage)
STATE_IDENTKennung des Status (sofern vergeben)
STATE_LANGLä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

Code Block
titleRü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

Code Block
titleAbfrage für Auftrag
https://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&CUSTORDERID=123456789


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


...