Änderungen von Dokument get_messages.php

Zuletzt geändert von YellowFox_RD am 2025/01/23 10:05
Von Version 2.1
bearbeitet von Dominic Lippmann
am 2025/01/17 15:25
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 1.1
bearbeitet von YellowFox_RD
am 2024/12/19 10:11
Änderungskommentar: Imported from XAR

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.yf-dominic
1 +XWiki.YellowFox_RD
Inhalt
... ... @@ -1,21 +1,14 @@
1 1  (% class="box" %)
2 -(((
3 -Inhaltsverzeichnis
4 -)))
5 -
2 +(((Inhaltsverzeichnis)))
6 6  {{toc/}}
7 7  
8 8  Liefert die Statusmeldungen für Nachrichten zurück.
9 -
10 10  = Beschreibung =
11 -
12 -(% 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//
13 -
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//
14 14  = Parameter =
15 -
16 -
9 + 
17 17  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
18 -|company|RTI Firmenschlüssel|string| |ja
11 +|company|RTI Firmenschlüssel|string||ja
19 19  |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
20 20  |group|RTI Gruppenschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
21 21  |import|RTI Importschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
... ... @@ -34,6 +34,7 @@
34 34  10 = Nachricht mit Antwortvorlagen gesendet
35 35  11 = Zugestellt
36 36  12 = Zustellungsversuch
30 +
37 37  mehrere Filter sind mit Komma getrennt anzugeben|nein
38 38  |language|Bestimmt die Ausgabesprache|string|(((
39 39  * kein Wert oder "deu" = Deutsch
... ... @@ -47,7 +47,6 @@
47 47  |mode|Abfrage nach Historydate oder Insertdate|string|Entweder historydate (standard) oder insertdate|nein
48 48  
49 49  = Mögliche Nachrichtenstatus =
50 -
51 51  |=Status|=Erläuterung
52 52  |Zustellungsversuch|Die Nachricht hat das YellowFox Rechenzentrum verlassen
53 53  |Zugestellt|Die Nachricht ist auf dem Display erfolgreich angekommen
... ... @@ -63,13 +63,10 @@
63 63  |Antwort erhalten|Eine Antwort des Displays ist eingegangen
64 64  
65 65  = 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
66 66  
67 -Es wird standardmäßig ein **CSV-String** zurückgegeben, welcher zu jedem Fahrzeug die Auswertung der Nachrichten enthält. Bei fehlenden Pflichtparametern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
68 -
69 69  == CSV-Format ==
70 -
71 71  === Metainformationen ===
72 -
73 73  |=Trennzeichen|Semikolon ( ; )
74 74  |=Textbegrenzer|Doppeltes Hochkomma ( " )
75 75  |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -76,17 +76,16 @@
76 76  |=Header|Zeile 1
77 77  
78 78  === Spalten ===
79 -
80 -|=Spalte|=Beschreibung|=
69 +|=Spalte|=Beschreibung|=
81 81  |DATE|Datum der ausgeführten Aktion|Format: YYYY-MM-DD HH:MM:SS
82 -|STATE|Beschreibung der Aktion|
83 -|SOURCE|Auslöser der Aktion (Person)|
84 -|SOURCENAME|Auslöser der Aktion (System)|
85 -|SESSIONKEY|Sessionkey der Nachricht|
71 +|STATE|Beschreibung der Aktion|
72 +|SOURCE|Auslöser der Aktion (Person)|
73 +|SOURCENAME|Auslöser der Aktion (System)|
74 +|SESSIONKEY|Sessionkey der Nachricht|
86 86  |REQUESTDATE|Systemzeit der Abfrage|Format: YYYY-MM-DD HH:MM:SS
87 87  |INSERTDATE|Systemzeit der Verarbeitung|Format: YYYY-MM-DD HH:MM:SS
88 -|TEXT|Inhalt der Nachricht|
89 -|RTI_IDENT|RTI Ident des Fahrzeuges|
77 +|TEXT|Inhalt der Nachricht|
78 +|RTI_IDENT|RTI Ident des Fahrzeuges|
90 90  
91 91  **Rückgabe als CSV**
92 92  {{code language="java"}}"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
... ... @@ -95,7 +95,6 @@
95 95  "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}}
96 96  
97 97  == XML Format ==
98 -
99 99  **Rückgabe als XML**
100 100  {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
101 101  <!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd">
... ... @@ -109,7 +109,7 @@
109 109   <requestdate>2016-12-05 10:17:15</requestdate>
110 110   <insertdate>2016-12-02 13:09:20</insertdate>
111 111   <text>Nachricht 1</text>
112 - <rti_ident>Ident1</rti_ident>
100 + <rti_ident>Ident1</rti_ident>
113 113   </message>
114 114   <message>
115 115   <date>2016-12-02 13:08:25</date>
... ... @@ -120,7 +120,7 @@
120 120   <requestdate>2016-12-05 10:17:15</requestdate>
121 121   <insertdate>2016-12-02 13:08:15</insertdate>
122 122   <text>Frage 1?</text>
123 - <rti_ident>Ident1</rti_ident>
111 + <rti_ident>Ident1</rti_ident>
124 124   </message>
125 125   <message>
126 126   <date>2016-12-02 09:09:15</date>
... ... @@ -131,12 +131,11 @@
131 131   <requestdate>2016-12-05 10:17:52</requestdate>
132 132   <insertdate>2016-12-02 09:09:20</insertdate>
133 133   <text>Antwort 1</text>
134 - <rti_ident>Ident1</rti_ident>
122 + <rti_ident>Ident1</rti_ident>
135 135   </message>
136 136  </yf_getmessages>{{/code}}
137 137  
138 138  == JSON Format (RFC 4627) ==
139 -
140 140  **Rückgabe als JSON**
141 141  {{code language="java"}}[
142 142  {"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"},