Änderungen von Dokument get_messages.php

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

Von Version 1.1
bearbeitet von YellowFox_RD
am 2024/12/19 10:11
Änderungskommentar: Imported from XAR
Auf Version 3.1
bearbeitet von YellowFox_RD
am 2025/01/20 11:21
Änderungskommentar: Replaced user [XWiki.yf-dominic] in fields [author, contentAuthor] to user [XWiki.YellowFox_RD]

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,14 +1,21 @@
1 1  (% class="box" %)
2 -(((Inhaltsverzeichnis)))
2 +(((
3 +Inhaltsverzeichnis
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Liefert die Statusmeldungen für Nachrichten zurück.
9 +
6 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//
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 +
8 8  = Parameter =
9
15 +
16 +
10 10  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
11 -|company|RTI Firmenschlüssel|string||ja
18 +|company|RTI Firmenschlüssel|string| |ja
12 12  |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
13 13  |group|RTI Gruppenschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
14 14  |import|RTI Importschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
... ... @@ -27,7 +27,6 @@
27 27  10 = Nachricht mit Antwortvorlagen gesendet
28 28  11 = Zugestellt
29 29  12 = Zustellungsversuch
30 -
31 31  mehrere Filter sind mit Komma getrennt anzugeben|nein
32 32  |language|Bestimmt die Ausgabesprache|string|(((
33 33  * kein Wert oder "deu" = Deutsch
... ... @@ -41,6 +41,7 @@
41 41  |mode|Abfrage nach Historydate oder Insertdate|string|Entweder historydate (standard) oder insertdate|nein
42 42  
43 43  = Mögliche Nachrichtenstatus =
50 +
44 44  |=Status|=Erläuterung
45 45  |Zustellungsversuch|Die Nachricht hat das YellowFox Rechenzentrum verlassen
46 46  |Zugestellt|Die Nachricht ist auf dem Display erfolgreich angekommen
... ... @@ -56,10 +56,13 @@
56 56  |Antwort erhalten|Eine Antwort des Displays ist eingegangen
57 57  
58 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 60  
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 +
61 61  == CSV-Format ==
70 +
62 62  === Metainformationen ===
72 +
63 63  |=Trennzeichen|Semikolon ( ; )
64 64  |=Textbegrenzer|Doppeltes Hochkomma ( " )
65 65  |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -66,16 +66,17 @@
66 66  |=Header|Zeile 1
67 67  
68 68  === Spalten ===
69 -|=Spalte|=Beschreibung|=
79 +
80 +|=Spalte|=Beschreibung|=
70 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|
82 +|STATE|Beschreibung der Aktion|
83 +|SOURCE|Auslöser der Aktion (Person)|
84 +|SOURCENAME|Auslöser der Aktion (System)|
85 +|SESSIONKEY|Sessionkey der Nachricht|
75 75  |REQUESTDATE|Systemzeit der Abfrage|Format: YYYY-MM-DD HH:MM:SS
76 76  |INSERTDATE|Systemzeit der Verarbeitung|Format: YYYY-MM-DD HH:MM:SS
77 -|TEXT|Inhalt der Nachricht|
78 -|RTI_IDENT|RTI Ident des Fahrzeuges|
88 +|TEXT|Inhalt der Nachricht|
89 +|RTI_IDENT|RTI Ident des Fahrzeuges|
79 79  
80 80  **Rückgabe als CSV**
81 81  {{code language="java"}}"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
... ... @@ -84,6 +84,7 @@
84 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 85  
86 86  == XML Format ==
98 +
87 87  **Rückgabe als XML**
88 88  {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
89 89  <!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd">
... ... @@ -97,7 +97,7 @@
97 97   <requestdate>2016-12-05 10:17:15</requestdate>
98 98   <insertdate>2016-12-02 13:09:20</insertdate>
99 99   <text>Nachricht 1</text>
100 - <rti_ident>Ident1</rti_ident>
112 + <rti_ident>Ident1</rti_ident>
101 101   </message>
102 102   <message>
103 103   <date>2016-12-02 13:08:25</date>
... ... @@ -108,7 +108,7 @@
108 108   <requestdate>2016-12-05 10:17:15</requestdate>
109 109   <insertdate>2016-12-02 13:08:15</insertdate>
110 110   <text>Frage 1?</text>
111 - <rti_ident>Ident1</rti_ident>
123 + <rti_ident>Ident1</rti_ident>
112 112   </message>
113 113   <message>
114 114   <date>2016-12-02 09:09:15</date>
... ... @@ -119,11 +119,12 @@
119 119   <requestdate>2016-12-05 10:17:52</requestdate>
120 120   <insertdate>2016-12-02 09:09:20</insertdate>
121 121   <text>Antwort 1</text>
122 - <rti_ident>Ident1</rti_ident>
134 + <rti_ident>Ident1</rti_ident>
123 123   </message>
124 124  </yf_getmessages>{{/code}}
125 125  
126 126  == JSON Format (RFC 4627) ==
139 +
127 127  **Rückgabe als JSON**
128 128  {{code language="java"}}[
129 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"},