get_messages.php

Zuletzt geändert von YellowFox_RD am 2025/01/23 10:05

Inhaltsverzeichnis

Beschreibung
Parameter
Mögliche Nachrichtenstatus
Rückgabe
Beispiele

Liefert die Statusmeldungen für Nachrichten zurück.

Beschreibung

GET get_messages.php?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&filter=1,2,3&sessionkey=ABABABABABABABABABABABABABABAB&format=xml&mode=insertdate

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
vehicle	RTI Fahrzeugschlüssel	string	entweder vehicle oder group oder import werden erwartet	(ja)
group	RTI Gruppenschlüssel	string	entweder vehicle oder group oder import werden erwartet	(ja)
import	RTI Importschlüssel	string	entweder vehicle oder group oder import werden erwartet	(ja)
start	Anfang des Abfragezeitraum	string	Format: YYYYMMDDHHMMSS	ja
end	Ende des Abfragezeitraum	string	Format: YYYYMMDDHHMMSS Die maximale Zeitspanne beträgt 7 Tage.	ja
filter	Filtermöglichkeit nach Nachrichtentyp	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	nein
language	Bestimmt die Ausgabesprache	string	kein Wert oder "deu" = Deutsch "gbr" = englisch "fra" = französisch "ita" = italienisch	nein
format	Rückgabeformat	string	Format der zurückgelieferten Antwort der Schnittstelle unterstützte Formate: csv (Standard), xml, json	nein
sessionkey	Enthält den Sessionkey aus "do_message.php"	string	Entweder dieses Feld ist gesetzt, oder start und end	ja
mode	Abfrage nach Historydate oder Insertdate	string	Entweder historydate (standard) oder insertdate	nein

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: YYYY-MM-DD HH:MM:SS
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: YYYY-MM-DD HH:MM:SS
INSERTDATE	Systemzeit der Verarbeitung	Format: YYYY-MM-DD HH:MM:SS
TEXT	Inhalt der Nachricht
RTI_IDENT	RTI Ident des Fahrzeuges

Rückgabe als CSV

"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
"2016-12-02 13:09:15";"Bestätigungsnachricht gesendet";"PORTAL";"Disponent 1";"";"2016-12-05 10:17:15";"2016-12-02 13:09:20";"Nachricht 1";"Ident1"
"2016-12-02 13:08:25";"Ja/Nein Nachricht gesendet";"PORTAL";"Disponent 1";"";"2016-12-05 10:17:15";"2016-12-02 13:08:15";"Frage 1?";"Ident1"
"2016-12-02 09:09:15";"Antwort erhalten";"PND";"Car 1";"ABABABABABABABABABABAB";"2016-12-05 10:17:52";"2016-12-02 09:09:20";"Antwort 1";"Ident1"

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>2016-12-02 13:09:15</date>
       <state>Bestätigungsnachricht gesendet</state>
       <source>PORTAL</source>
       <sourcename>Disponent 1</sourcename>
       <sessionkey/>
       <requestdate>2016-12-05 10:17:15</requestdate>
       <insertdate>2016-12-02 13:09:20</insertdate>
       <text>Nachricht 1</text>
<rti_ident>Ident1</rti_ident>
   </message>
   <message>
       <date>2016-12-02 13:08:25</date>
       <state>Ja/Nein Nachricht gesendet</state>
       <source>PORTAL</source>
       <sourcename>Disponent 1</sourcename>
       <sessionkey/>
       <requestdate>2016-12-05 10:17:15</requestdate>
       <insertdate>2016-12-02 13:08:15</insertdate>
       <text>Frage 1?</text>
<rti_ident>Ident1</rti_ident>
   </message>
   <message>
       <date>2016-12-02 09:09:15</date>
       <state>Antwort erhalten</state>
       <source>PND</source>
       <sourcename>Car 1</sourcename>
       <sessionkey>ABABABABABABABABABABAB</sessionkey>
       <requestdate>2016-12-05 10:17:52</requestdate>
       <insertdate>2016-12-02 09:09:20</insertdate>
       <text>Antwort 1</text>
<rti_ident>Ident1</rti_ident>
   </message>
</yf_getmessages>

JSON Format (RFC 4627)

Rückgabe als JSON

[
{"date":"2016-12-02 13:09:15","state":"Bestätigungsnachricht gesendet","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"2016-12-05 10:17:15","insertdate":"2016-12-02 13:09:20","text":"Nachricht 1","rti_ident":"Ident1"},
{"date":"2016-12-02 13:08:25","state":"Ja\/Nein Nachricht gesendet","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"2016-12-05 10:17:15","insertdate":"2016-12-02 13:08:15","text":"Frage 1?","rti_ident":"Ident1"},
{"date":"2016-12-02 09:09:15","state":"Antwort erhalten","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"2016-12-05 10:17:52","insertdate":"2016-12-02 09:09:20","text":"Antwort 1","rti_ident":"Ident1"}
]

Beispiele

Abfrage über SessionKey

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

https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&language=deu&sessionkey=SESSION_KEY

Abfrage über Zeitraum

https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&start=20161202083015&end=20161205161500&filter=1,2,4,11&format=xml&mode=insertdate