...
| 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) |
| datefrom | Datum ab dem alle Aufträge zurückgegeben werden | string | Format: YYYYMMDD oder DD.MM.YYYY | ja |
| datefrom | Datum bis zu dem alle Aufträge zurückgegeben werden | string | Format: YYYYMMDD oder DD.MM.YYYY Die maximale Zeitspanne beträgt 7 Tage. | ja |
| timefrom | Präzisierung des Anfangsdatums mit der Zeit | string | Format: HHMMSS | nein |
| timeto | Präzisierung des Enddatums mit der Zei | string | Format: HHMMSS | nein |
| filter | Filtermöglichkeit nach Nachrichtentyp | integer | 1 = Antwort erhalten
| nein |
| language | Bestimmt die Ausgabesprache | string |
| nein |
| format | Rückgabeformat | string | Format der zurückgelieferten Antwort der Schnittstelle unterstüzte Formate: csv (Standard), xml, json | nein
|
| sessionkey | enthaelt Enthält den Sessionkey aus "do_message.php" | string | Entweder dieses Feld ist gesetzt, oder DATEFROM und DATETO | ja |
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 |
...
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
...
Metainformationen
| Trennzeichen | Semikolon ( ; ) |
|---|---|
| Textbegrenzer | Doppeltes Hochkomma ( " ) |
| Zeilenende | 0x0D 0x0A (CarriageReturn LineFeed) |
| Header | Zeile 1 |
Beispiele
| Code Block | ||
|---|---|---|
| ||
"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"
|
| Code Block | ||
|---|---|---|
| ||
<?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>
|
| Code Block | ||
|---|---|---|
| ||
[
{"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"}
] | ||
| Code Block | ||
| ||
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 |
Beispiele
| Code Block | ||
|---|---|---|
| ||
http://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY |
...