Liefert die Statusmeldungen für Nachrichten zurück.

Beschreibung

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

Params	Description	Type	Note	Mandatory
company	RTI company key	string		yes
vehicle	RTI vehcile key	string	vehicle or import or group parameter	(yes)
group	RTI group key	string	vehicle or import or group parameter	(yes)
import	RTI importkey	string	vehicle or import or group parameter	(yes)
datefrom	begin of requested timerange	string	format: YYYYMMDD or DD.MM.YYYY	yes
dateto	end of requested timerange	string	format: YYYYMMDD or DD.MM.YYYY max. timerange is 7 days	yes
timefrom	more precise of datefrom	string	format: HHMMSS	no
timeto	more precise of dateto	string	format: HHMMSS	no
filter	filter the type of messages	integer	1 = Antwort erhalten 2 = Bestätigungsnachricht gesendet 3 = Display ausgeschaltet 4 = Ja/Nein 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 mehrere Filter sind mit Komma getrennt anzugeben	no
language	define output language	string	kein Wert oder "deu" = Deutsch "gbr" = englisch "fra" = französisch "ita" = italienisch	no
format	result format	string	Format der zurückgelieferten Antwort der Schnittstelle unterstützte Formate: csv (Standard), xml, json	no
sessionkey	SessionKey from "do_message.asp	string	this field or datefrom and dateto are mandatory	yes

Mögliche Nachrichtenstatus

Status	Erläuterung
Zustellungsversuch	Die Nachricht hat das YellowFox Rechenzentrum verlassen
Zugestellt	Die Nachricht ist auf dem Display erfolgreich angekommen
Display ausgeschaltet	Das Display kann die Nachricht nicht empfangen, da es ausgeschaltet ist
Nachricht bereits vorhanden	Die Nachricht kann nicht erneut zugestellt werden, da diese bereits vorhanden ist
Nachricht erhalten	Es ist eine Nachricht im Portal angekommen, welche auf einem Display erstellt wurde
Nachricht gelesen	Nachricht wurde auf dem Display gelesen
Nachricht gelöscht	Nachricht wurde auf dem Display gelöscht
Nachricht konnte nicht zugestellt werden	Die Nachricht hat das Display nicht erreicht, weitere Zustellungsversuche werden nicht durchgeführt
Nachricht mit Antwortvorlagen gesendet	Die Nachricht wurde mit Antwortvorlagen versendet
Ja/Nein Nachricht gesendet	Die Nachricht wurde mit einer Ja-Nein-Option als Antwort versendet
Bestätigungsnachricht gesendet	Die Nachricht wurde mit einer Bestätigungsoption versendet
Antwort erhalten	Eine Antwort des Displays ist eingegangen

Rückgabe

Es wird standardmäßig ein CSV-String zurückgegeben, welcher zu jedem Fahrzeug die Auswertung der Nachrichten enthält. Bei fehlenden Pflichtparametern wird ein "ERROR:Beschreibung" zurückgegeben

CSV-Format

Metainformationen

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

Spalten

Spalte	Beschreibung
DATE	Datum der ausgeführten Aktion	Format: DD.MM.YYYY HH:MM
STATE	Beschreibung der Aktion
SOURCE	Auslöser der Aktion (Person)
SOURCENAME	Auslöser der Aktion (System)
SESSIONKEY	Sessionkey der Nachricht
REQUESTDATE	Systemzeit der Abfrage	Format: DD.MM.YYYY HH:MM
INSERTDATE	Systemzeit der Verarbeitung	Format: DD.MM.YYYY HH:MM
TEXT	Inhalt der Nachricht

Rückgabe als CSV

"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT"
"02.12.2016 - 13:09";"Bestätigungsnachricht gesendet";"PORTAL";"Disponent 1";"";"05.12.2016 - 10:17";"02.12.2016 - 13:09";"Nachricht 1"
"02.12.2016 - 13:08";"Ja/Nein Nachricht gesendet";"PORTAL";"Disponent 1";"";"05.12.2016 - 10:17";"02.12.2016 - 13:08";"Frage 1?"
"02.12.2016 - 09:09";"Antwort erhalten";"PND";"Car 1";"ABABABABABABABABABABAB";"05.12.2016 - 10:17";"02.12.2016 - 09:09";"Antwort 1"

XML Format

Rückgabe als XML

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd">
<yf_getmessages>
    <message>
        <date>02.12.2016 - 13:09</date>
        <state>Bestätigungsnachricht gesendet</state>
        <source>PORTAL</source>
        <sourcename>Disponent 1</sourcename>
        <sessionkey/>
        <requestdate>05.12.2016 - 09:49</requestdate>
        <insertdate>02.12.2016 - 13:09</insertdate>
        <text>Nachricht 1</text>
    </message>
    <message>
        <date>02.12.2016 - 13:08</date>
        <state>Ja/Nein Nachricht gesendet</state>
        <source>PORTAL</source>
        <sourcename>Disponent 1</sourcename>
        <sessionkey/>
        <requestdate>05.12.2016 - 09:49</requestdate>
        <insertdate>02.12.2016 - 13:08</insertdate>
        <text>Frage 1?</text>
    </message>
    <message>
        <date>02.12.2016 - 09:09</date>
        <state>Antwort erhalten</state>
        <source>PND</source>
        <sourcename>Car 1</sourcename>
        <sessionkey>ABABABABABABABABABABAB</sessionkey>
        <requestdate>05.12.2016 - 09:49</requestdate>
        <insertdate>02.12.2016 - 09:09</insertdate>
        <text>Antwort 1</text>
    </message>
</yf_getmessages>

JSON Format (RFC 4627)

Rückgabe als JSON

[
{"date":"02.12.2016 - 13:09","state":"Bestätigungsnachricht gesendet","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"05.12.2016 - 09:49","insertdate":"02.12.2016 - 13:09","text":"Nachricht 1"},
{"date":"02.12.2016 - 13:08","state":"Ja\/Nein Nachricht gesendet","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"05.12.2016 - 09:49","insertdate":"02.12.2016 - 13:08","text":"Frage 1?"},
{"date":"02.12.2016 - 09:09","state":"Antwort erhalten","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"05.12.2016 - 09:49","insertdate":"02.12.2016 - 09:09","text":"Antwort 1"}

Beispielaufrufe

Abfrage über SessionKey

http://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY

Abfrage über Zeitraum auf Basis des Insertdate

 http://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&datefrom=20161202&dateto=05.12.2016&timefrom=083015&timeto=161500&filter=1,2,4,11&format=xml

Page tree

get_messages.php