Wiki-Quellcode von get_messages.php

Version 1.1 von YellowFox_RD am 2024/12/19 10:11
Verstecke letzte Bearbeiter
YellowFox_RD 1.1 1 (% class="box" %)
2 (((Inhaltsverzeichnis)))
3 {{toc/}}
4
5 Liefert die Statusmeldungen für Nachrichten zurück.
6 = Beschreibung =
7 //**(% class="green mark" %)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//
8 = Parameter =
9  
10 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
11 |company|RTI Firmenschlüssel|string||ja
12 |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
13 |group|RTI Gruppenschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
14 |import|RTI Importschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
15 |start|Anfang des Abfragezeitraum|string|Format: YYYYMMDDHHMMSS|ja
16 |end|Ende des Abfragezeitraum|string|Format: YYYYMMDDHHMMSS
17 Die maximale Zeitspanne beträgt 7 Tage.|ja
18 |filter|Filtermöglichkeit nach Nachrichtentyp|integer|1 = Antwort erhalten
19 2 = Bestätigungsnachricht gesendet
20 3 = Display ausgeschaltet
21 4 = Ja/Nein Nachricht gesendet
22 5 = Nachricht bereits vorhanden
23 6 = Nachricht erhalten
24 7 = Nachricht gelesen
25 8 = Nachricht gelöscht
26 9 = Nachricht konnte nicht zugestellt werden
27 10 = Nachricht mit Antwortvorlagen gesendet
28 11 = Zugestellt
29 12 = Zustellungsversuch
30
31 mehrere Filter sind mit Komma getrennt anzugeben|nein
32 |language|Bestimmt die Ausgabesprache|string|(((
33 * kein Wert oder "deu" = Deutsch
34 * "gbr" = englisch
35 * "fra" = französisch
36 * "ita" = italienisch
37 )))|nein
38 |format|Rückgabeformat|string|Format der zurückgelieferten Antwort der Schnittstelle
39 unterstützte Formate: csv (Standard), xml, json|nein
40 |sessionkey|Enthält den Sessionkey aus "do_message.php"|string|Entweder dieses Feld ist gesetzt, oder start und end|ja
41 |mode|Abfrage nach Historydate oder Insertdate|string|Entweder historydate (standard) oder insertdate|nein
42
43 = Mögliche Nachrichtenstatus =
44 |=Status|=Erläuterung
45 |Zustellungsversuch|Die Nachricht hat das YellowFox Rechenzentrum verlassen
46 |Zugestellt|Die Nachricht ist auf dem Display erfolgreich angekommen
47 |Display ausgeschaltet|Das Display kann die Nachricht nicht empfangen, da es ausgeschaltet ist
48 |Nachricht bereits vorhanden|Die Nachricht kann nicht erneut zugestellt werden, da diese bereits vorhanden ist
49 |Nachricht erhalten|Es ist eine Nachricht im Portal angekommen, welche auf einem Display erstellt wurde
50 |Nachricht gelesen|Nachricht wurde auf dem Display gelesen
51 |Nachricht gelöscht|Nachricht wurde auf dem Display gelöscht
52 |Nachricht konnte nicht zugestellt werden|Die Nachricht hat das Display nicht erreicht, weitere Zustellungsversuche werden nicht durchgeführt
53 |Nachricht mit Antwortvorlagen gesendet|Die Nachricht wurde mit Antwortvorlagen versendet
54 |Ja/Nein Nachricht gesendet|Die Nachricht wurde mit einer Ja-Nein-Option als Antwort versendet
55 |Bestätigungsnachricht gesendet|Die Nachricht wurde mit einer Bestätigungsoption versendet
56 |Antwort erhalten|Eine Antwort des Displays ist eingegangen
57
58 = Rückgabe =
59 Es wird standardmäßig ein **CSV-S****tring** zurückgegeben, welcher zu jedem Fahrzeug die Auswertung der Nachrichten enthält. Bei fehlenden Pflichtparametern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
60
61 == CSV-Format ==
62 === Metainformationen ===
63 |=Trennzeichen|Semikolon ( ; )
64 |=Textbegrenzer|Doppeltes Hochkomma ( " )
65 |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
66 |=Header|Zeile 1
67
68 === Spalten ===
69 |=Spalte|=Beschreibung|=
70 |DATE|Datum der ausgeführten Aktion|Format: YYYY-MM-DD HH:MM:SS
71 |STATE|Beschreibung der Aktion|
72 |SOURCE|Auslöser der Aktion (Person)|
73 |SOURCENAME|Auslöser der Aktion (System)|
74 |SESSIONKEY|Sessionkey der Nachricht|
75 |REQUESTDATE|Systemzeit der Abfrage|Format: YYYY-MM-DD HH:MM:SS
76 |INSERTDATE|Systemzeit der Verarbeitung|Format: YYYY-MM-DD HH:MM:SS
77 |TEXT|Inhalt der Nachricht|
78 |RTI_IDENT|RTI Ident des Fahrzeuges|
79
80 **Rückgabe als CSV**
81 {{code language="java"}}"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
82 "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"
83 "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"
84 "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"{{/code}}
85
86 == XML Format ==
87 **Rückgabe als XML**
88 {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
89 <!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd">
90 <yf_getmessages>
91 <message>
92 <date>2016-12-02 13:09:15</date>
93 <state>Bestätigungsnachricht gesendet</state>
94 <source>PORTAL</source>
95 <sourcename>Disponent 1</sourcename>
96 <sessionkey/>
97 <requestdate>2016-12-05 10:17:15</requestdate>
98 <insertdate>2016-12-02 13:09:20</insertdate>
99 <text>Nachricht 1</text>
100 <rti_ident>Ident1</rti_ident>
101 </message>
102 <message>
103 <date>2016-12-02 13:08:25</date>
104 <state>Ja/Nein Nachricht gesendet</state>
105 <source>PORTAL</source>
106 <sourcename>Disponent 1</sourcename>
107 <sessionkey/>
108 <requestdate>2016-12-05 10:17:15</requestdate>
109 <insertdate>2016-12-02 13:08:15</insertdate>
110 <text>Frage 1?</text>
111 <rti_ident>Ident1</rti_ident>
112 </message>
113 <message>
114 <date>2016-12-02 09:09:15</date>
115 <state>Antwort erhalten</state>
116 <source>PND</source>
117 <sourcename>Car 1</sourcename>
118 <sessionkey>ABABABABABABABABABABAB</sessionkey>
119 <requestdate>2016-12-05 10:17:52</requestdate>
120 <insertdate>2016-12-02 09:09:20</insertdate>
121 <text>Antwort 1</text>
122 <rti_ident>Ident1</rti_ident>
123 </message>
124 </yf_getmessages>{{/code}}
125
126 == JSON Format (RFC 4627) ==
127 **Rückgabe als JSON**
128 {{code language="java"}}[
129 {"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"},
130 {"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"},
131 {"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"}
132 ] {{/code}}
133
134 = Beispiele =
135
136 **Abfrage über SessionKey**
137 {{code language="java"}}https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
138
139 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{{/code}}
140
141 **Abfrage über Zeitraum **
142 {{code language="java"}}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{{/code}}
143