Versions Compared

Key

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

...

get_messages.php?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&datefrom=YYYYMMDD&dateto=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&filter=1,2,3&sessionkey=ABABABABABABABABABABABABABABAB&format=xml

 

Parameter

...

 

Pflicht
ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring ja
vehicleRTI Fahrzeugschlüsselstringentweder vehicle oder group oder import werden erwartet(ja)
groupRTI Gruppenschlüsselstringentweder vehicle oder group oder import werden erwartet(ja)
importRTI Importschlüsselstringentweder vehicle oder group oder import werden erwartet(ja)
datefromDatum ab dem alle Aufträge zurückgegeben werden stringFormat: YYYYMMDD oder DD.MM.YYYYja
datefromDatum bis zu dem alle Aufträge zurückgegeben werden string

Format: YYYYMMDD oder DD.MM.YYYY

Die maximale Zeitspanne beträgt 7 Tage.

ja
timefromPräzisierung des Anfangsdatums mit der Zeit stringFormat: HHMMSSnein
timetoPräzisierung des Enddatums mit der Zei stringFormat: HHMMSSnein
filterTyp der AntwortmöglichkeitFiltermöglichkeit nach Nachrichtentypinteger

1 = keine vorgegebene Antwort (Standard)erhalten
2 =
Bestätigung erwartetBestätigungsnachricht gesendet
3 = Display ausgeschaltet
4 = Ja
-/Nein -Antwort erwartet

4 = vorgegebene Antworten ( für Fleet-Displays ab Version 3.0)

neinfreeresponsesvorgegebene Antwortmöglichkeitenserialisiertes Array

Nachricht gesendet
5 = Nachricht bereits vorhanden
6 = Nachricht erhalten
7 = Nachricht gelesen
8 = Nachricht gelöscht
9 = Nachricht konnte nicht zugestellt werden
10 = Nachricht mit Antwortvorlagen gesendet
11 = Zugestellt
12 = Zustellungsversuch

notwendig für responsetype = 4


mehrere Filter sind mit Komma getrennt anzugeben


nein
languageBestimmt die Ausgabesprachestring
  • kein Wert oder "deu" = Deutsch
  • "gbr" = englisch
  • "fra" = französisch
  • "ita" = italienisch
nein
 formatRückgabeformatstring

 Format der zurückgelieferten Antwort der Schnittstelle

unterstüzte Formate: csv (Standard), xml, json

nein

 

Parameter
Beschreibung
Typ
Hinweis

sessionkeyenthaelt den Sessionkey aus "do_message.aspphp"stringEntweder dieses Feld ist gesetzt, oder DATEFROM und DATETOja
datefromDatum ab dem alle Aufträge zurückgegeben werdenstringFormat: YYYYMMDD oder DD.MM.YYYYja
datetoDatum bis zu dem alle Aufträge zurückgegeben werdenstringFormat: YYYYMMDD oder DD.MM.YYYYDie maximale Zeitspanne beträgt 7 Tage.jatimefromPrä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

 


Mögliche Nachrichtenstatus

StatusErläuterung
ZustellungsversuchDie Nachricht hat das YellowFox Rechenzentrum verlassen
ZugestelltDie Nachricht ist auf dem Display erfolgreich angekommen
Display ausgeschaltetDas Display kann die Nachricht nicht empfangen, da es ausgeschaltet ist
Nachricht bereits vorhandenDie Nachricht kann nicht erneut zugestellt werden, da diese bereits vorhanden ist
Nachricht erhaltenEs ist eine Nachricht im Portal angekommen, welche auf einem Display erstellt wurde
Nachricht gelesenNachricht wurde auf dem Display gelesen
Nachricht gelöschtNachricht wurde auf dem Display gelöscht
Nachricht konnte nicht zugestellt werdenDie Nachricht hat das Display nicht erreicht, weitere Zustellungsversuche werden nicht durchgeführt
Nachricht mit Antwortvorlagen gesendetDie Nachricht wurde mit Antwortvorlagen versendet
Ja/Nein Nachricht gesendetDie Nachricht wurde mit einer Ja-Nein-Option als Antwort versendet
Bestätigungsnachricht gesendetDie Nachricht wurde mit einer Bestätigungsoption versendet
Antwort erhaltenEine Antwort des Displays ist eingegangen

Rückgabe

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


Abfrage über Sessionkey

Metainformationen

...

Spalten

Spalte
Beschreibung
 
DATEDatum der ausgeführten AktionFormat: DD.MM.YYYY HH:MM:SS
STATEBeschreibung der Aktion 
SOURCEAuslöser der AktionPerson/Fahrzeugkennzeichen

...

Rückgabe über Zeitraumabfrage

Metainformationen

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

...