Returns the states of the messages. Description get Liefert die Statusmeldungen für Nachrichten zurück. Beschreibungget_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&mode=insertdate Parameter Params | Description | Type | Note | Mandatory |
---|
company | RTI company key | string |
| ja
| yes | vehicle | RTI vehcile key | string | entweder oder group oder import werden erwartetor import or group parameter | ( | jayes) | group | RTI group key | string | entweder oder group oder import werden erwartetor import or group parameter | ( | jayes) | import | RTI importkey | string | entweder oder group oder import werden erwartetor import or group parameter | ( | jadatefrom | 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 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 anzugebennein | 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üzte Formate: csv (Standard), xml, json | nein | sessionkey | Enthält den Sessionkey aus "do_message.php" | string | Entweder dieses Feld ist gesetzt, oder DATEFROM und DATETO | ja | Mögliche NachrichtenstatusStatus | 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ückgabeEs 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 start | begin of requested timerange | datestring | format: YYYYMMDDHHMMSS | yes | end | end of requested timerange | datestring | format: YYYYMMDDHHMMSS max. timerange is 7 days | yes | filter | filter the type of messages | integer | 1 = answer received 2 = confirmation message sent 3 = display off 4 = yes/no message sent 5 = message already exists 6 = message received 7 = message read 8 = message deleted 9 = message could not be sent 10 = message with response templates sent 11 = delivered 12 = delivery attempt
more than one filter have to separate with a comma
| no | language | define output language | string | supported params: deu (standard), gbr, ndl, fra, ita | no | format | result format | string | format of the result from the interface supported formats: csv (standard), xml, json | no
| sessionkey | SessionKey from "do_message.asp | string | this field or datefrom and dateto are mandatory | yes | mode | Request of historydate or insertdate | string | historydate (standard) or insertdate | no |
Possible message statusState | Description |
---|
delivery attempt | The message left the YellowFox data center. | delivered | The message has arrived successfully on the display. | display off | The display can not receive the message because it is off. | message already exists | The message can not be recached, because it already exists. | message received | A message has arrived in the portal, which was created on a display. | message read | Message was read on the display. | message deleted | Message has been deleted on the display. | message could not be sent | The message has not reached the display, further delivery attempts are not carried out. | message with response templates sent | The message was sent with reply templates. | yes/no message sent | The message was sent with a yes-no option as a response. | confirmation message sent | The message was sent with a confirmation option. | answer received | A response from the display has been received. |
ReturnBy default, a CSV string is returned which contains the evaluation for each message. If the mandatory parameters are missing, an "ERROR: Description" is returned. Separator | Semicolon ( ; ) |
---|
Delimiter | Double quote ( " ) |
---|
Line break |
---|
Trennzeichen | Semikolon ( ; ) |
---|
Textbegrenzer | Doppeltes Hochkomma ( " ) | Zeilenende | 0x0D 0x0A (CarriageReturn LineFeed) |
---|
Header |
---|
Zeile SpaltenColumnsSpalte | Datum der ausgeführten Aktion | date of the executed action | format: YYYY-MM-DD | Format: DD.MM.YYYY Beschreibung der Aktion | description of the action |
| SOURCE |
Auslöser der Aktion (Person) | action trigger (person) |
| SOURCENAME |
Auslöser der Aktion (System) | action trigger (system) |
| SESSIONKEY |
Sessionkey der Nachricht | sessionkey of message |
| REQUESTDATE |
Systemzeit der Abfrage | system time of request | format: YYYY-MM-DD | Format: DD.MM.YYYY Systemzeit der Verarbeitung | system time of processing | format: YYYY-MM-DD | Format: DD.MM.YYYY Inhalt der Nachricht | | content of the message |
| RTI_IDENT | RTI Ident |
Code Block |
---|
title | Rückgabe als result as CSV |
---|
| "DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"TEXTRTI_IDENT"
""02.12.2016 -2016-12-02 13:09:15";"Bestätigungsnachrichtconfirmation message gesendetsent";"PORTAL";"Disponent 1";"";"05.12.2016 -2016-12-05 10:17:15";"02.12.2016 -2016-12-02 13:09:20";"NachrichtMessage 1";"Ident1"
"02.12.2016 -2016-12-02 13:08:25";"Jayes/Neinno Nachrichtmessage gesendetsent";"PORTAL";"Disponent 1";"";"05.12.2016 -2016-12-05 10:17:15";"02.12.2016 -2016-12-02 13:08:15";"FrageQuestion 1?";"Ident1"
"02.12.2016 -2016-12-02 09:09:15";"Antwortanswer erhaltenreceived";"PND";"Car 1";"ABABABABABABABABABABAB";"05.12.2016 -2016-12-05 10:17:52";"02.12.2016 -2016-12-02 09:09:20";"Antwort 1Answer 1";"Ident1"
| Format Code Block |
---|
title | Rückgabe als result as 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 -<date>2016-12-02 13:09:09<15</date>
<state>confirmation <state>Bestätigungsnachrichtmessage gesendet<sent</state>
<source>PORTAL</source>
<sourcename>Disponent 1</sourcename>
<sessionkey/>
<requestdate>05.12.2016 - 09:49<<requestdate>2016-12-05 10:17:15</requestdate>
<insertdate>02.12.2016 -<insertdate>2016-12-02 13:09:09<20</insertdate>
<text>Nachricht<text>Message 1</text>/text>
<rti_ident>Ident1</rti_ident>
</message>
<message>
<date>02.12.2016 -<date>2016-12-02 13:08:08<25</date>
<state>Ja<state>yes/Neinno Nachrichtmessage gesendet<sent</state>
<source>PORTAL</source>
<sourcename>Disponent 1</sourcename>
<sessionkey/>
<requestdate>05.12.2016 - 09:49<<requestdate>2016-12-05 10:17:15</requestdate>
<insertdate>02.12.2016 -<insertdate>2016-12-02 13:08:08<15</insertdate>
<text>Frage<text>Question 1?</text>
<rti_ident>Ident1</rti_ident>
</message>
<message>
<date>02.12.2016 - 09:09<<date>2016-12-02 09:09:15</date>
<state>Antwort<state>answer erhalten<received</state>
<source>PND</source>
<sourcename>Car 1</sourcename>
<sessionkey>ABABABABABABABABABABAB</sessionkey>
<requestdate>05.12.2016 - 09:49<<requestdate>2016-12-05 10:17:52</requestdate>
<insertdate>02.12.2016 - 09:09<<insertdate>2016-12-02 09:09:20</insertdate>
<text>Antwort<text>Answer 1</text>
<rti_ident>Ident1</rti_ident>
</message>
</yf_getmessages>
|
Code Block |
---|
title | Rückgabe als result as JSON |
---|
| [
{"date":"02.12.2016 -2016-12-02 13:09:15","state":"Bestätigungsnachrichtconfirmation message gesendetsent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"05.12.2016 - 09:492016-12-05 10:17:15","insertdate":"02.12.2016 -2016-12-02 13:09:20","text":"NachrichtMessage 1"},
{"date":"02.12.2016 -2016-12-02 13:08:25","state":"Ja\yes/Neinno Nachrichtmessage gesendetsent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"05.12.2016 - 09:492016-12-05 10:17:15","insertdate":"02.12.2016 -2016-12-02 13:08:15","text":"FrageQuestion 1?"},
{"date":"02.12.2016 -2016-12-02 09:09:15","state":"Antwortanswer erhaltenreceived","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"05.12.2016 - 09:49","insertdate":"02.12.2016 - 09:09","text":"Antwort 1"}
|
Beispielaufrufe 2016-12-05 10:17:52","insertdate":"2016-12-02 09:09:20","text":"Answer 1","rti_ident":"Ident1"}]
|
Example call
Code Block |
---|
| https://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
https | Code Block |
---|
title | Abfrage über SessionKey |
---|
| http://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEYphp?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&language=deu&sessionkey=SESSION_KEY |
Code Block |
---|
title | Abfrage über Zeitraum auf Basis des Insertdate | Query by time range based |
---|
| https http://map.yellowfox.de/rti/get_messagestatemessages.aspphp?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&datefromstart=2016120220161202083015&dateto=05.12.2016&timefrom=083015&timeto=161500end=20161205161500&filter=1,2,4,11&format=xml&mode=insertdate |
|