Änderungen von Dokument do_message.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Von Version 4.1
bearbeitet von YellowFox_RD
am 2025/01/20 15:36
Änderungskommentar: Replaced user [XWiki.YellowFox_RD] in fields [author, contentAuthor, creator] to user [XWiki.yf-dominic]
Auf Version 1.1
bearbeitet von YellowFox_RD
am 2024/12/19 10:11
Änderungskommentar: Imported from XAR

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,24 +1,18 @@
1 1  (% class="box" %)
2 -(((
3 -Inhaltsverzeichnis
4 -)))
5 -
2 +(((Inhaltsverzeichnis)))
6 6  {{toc/}}
7 7  
8 8  Eine Nachricht an ein einzelnes Fahrzeug, eine Gruppe oder alle (import) senden.
9 -
10 10  = Beschreibung =
11 -
12 -(% class="blue mark" %)//**POST**//(%%)//** do_message.php?company**//=COMPANY_RTIKEY**&vehicle**=VEHICLE_RTIKEY//**&messagetext**//=Nachricht//**&language**//=deu//**&responsetype**//=2//**&format**//=xml//**&freeresponses[]**//=Montag**&freeresponses[]**=Dienstag**&dispatcher**=Absender
13 -
7 +//**(% class="blue mark" %)POST(%%) do_message.php?company**//=COMPANY_RTIKEY**&vehicle**=VEHICLE_RTIKEY//**&messagetext**//=Nachricht//**&language**//=deu//**&responsetype**//=2//**&format**//=xml//**&freeresponses[]**//=Montag**&freeresponses[]**=Dienstag**&dispatcher**=Absender
14 14  = Parameter =
15 -
16 16  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
17 -|company|RTI Firmenschlüssel|string| |ja
10 +|company|RTI Firmenschlüssel|string||ja
18 18  |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
19 19  |group|RTI Gruppenschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
20 20  |import|RTI Importschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
21 -|messagetext| |string|Maximale Nachrichtenlänge:(((
14 +|messagetext||string|Maximale Nachrichtenlänge:
15 +(((
22 22  * CE-Displays + Android Fleet: 500 Zeichen
23 23  * Alle anderen Displays: 200 Zeichen
24 24  )))|ja
... ... @@ -37,13 +37,10 @@
37 37  Die UUIDs erhalten Sie bei Hochladen der Datei über file_storage/upload_file.php oder per Abruf über file_storage/get_overview.php|nein
38 38  
39 39  = Rückgabe =
34 +Es wird standardmäßig ein **CSV-S****tring** zurückgegeben, welcher zu jedem Fahrzeug die Auswertung und bei erfolgreichen Versenden auch den **SESSIONKEY** enthält. Bei fehlenden Pflichtparametern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
40 40  
41 -Es wird standardmäßig ein **CSV-String** zurückgegeben, welcher zu jedem Fahrzeug die Auswertung und bei erfolgreichen Versenden auch den **SESSIONKEY** enthält. Bei fehlenden Pflichtparametern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
42 -
43 43  == CSV-Format ==
44 -
45 45  === Metainformationen ===
46 -
47 47  |=Trennzeichen|Semikolon ( ; )
48 48  |=Textbegrenzer|Doppeltes Hochkomma ( " )
49 49  |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -50,7 +50,6 @@
50 50  |=Header|Zeile 1
51 51  
52 52  === Spalten ===
53 -
54 54  |=Spalte|=Beschreibung
55 55  |CAR|Vehicle-Name
56 56  |RESULT|Resultat der Aktion
... ... @@ -57,7 +57,6 @@
57 57  |SESSIONKEY|Sessionkey der Nachricht
58 58  
59 59  === Beispiel ===
60 -
61 61  **Rückgabe als CSV**
62 62  {{code language="java"}}"CAR";"RESULT";"SESSIONKEY"
63 63  "Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
... ... @@ -65,30 +65,28 @@
65 65  "Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""{{/code}}
66 66  
67 67  == XML Format ==
68 -
69 69  **Rückgabe als XML**
70 70  {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
71 71  <!DOCTYPE yf_domessage SYSTEM "https://map.yellowfox.de/rti/dtd/yf_domessage.dtd">
72 72  <yf_domessage>
73 - <message>
74 - <car>Car 1</car>
75 - <result>ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED</result>
76 - <sessionkey></sessionkey>
77 - </message>
78 - <message>
79 - <car>Car 2</car>
80 - <result>OK</result>
81 - <sessionkey>8a810da98bc0583af5959af0e8dde59g</sessionkey>
82 - </message>
83 - <message>
84 - <car>Car 3</car>
85 - <result>ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3</result>
86 - <sessionkey></sessionkey>
87 - </message>
61 + <message>
62 + <car>Car 1</car>
63 + <result>ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED</result>
64 + <sessionkey></sessionkey>
65 + </message>
66 + <message>
67 + <car>Car 2</car>
68 + <result>OK</result>
69 + <sessionkey>8a810da98bc0583af5959af0e8dde59g</sessionkey>
70 + </message>
71 + <message>
72 + <car>Car 3</car>
73 + <result>ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3</result>
74 + <sessionkey></sessionkey>
75 + </message>
88 88   </yf_domessage>{{/code}}
89 89  
90 90  == JSON Format (RFC 4627) ==
91 -
92 92  **Rückgabe als JSON**
93 93  {{code language="java"}}[{"car":"Car 1","result":"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED"},{"car":"Car 2","result":"OK","sessionkey":"8a810da98bc0583af5959af0e8dde59g"},{"car":"Car 3","result":"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3"}]{{/code}}
94 94  
... ... @@ -99,14 +99,14 @@
99 99  
100 100  https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&messagetext=RTI%20do_message%20test{{/code}}
101 101  
102 -**Bestätigungsnachricht an Gruppe mit englischer Bestätigung und gewünschten Rückgabeformat als CSV**
103 -{{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=2&language=gbr&format=csv{{/code}}**
89 +** Bestätigungsnachricht an Gruppe mit englischer Bestätigung und gewünschten Rückgabeformat als CSV**
90 +{{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=2&language=gbr&format=csv{{/code}}
104 104  
105 105  **Ja-Nein-Nachricht an alle mit englischer Bestätigung und gewünschten Rückgabeformat als XML**
106 106  {{code language="java"}} https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=3&language=gbr&format=xml{{/code}}
107 107  
108 -**Nachricht mit Antwortvorlage an alle, mit gewünschten Rückgabeformat als xml und der Antwortvorlage als serialisiertem Array**
109 -{{code language="java"}} https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=4&format=xml&freeresponses[]=Montag&freeresponses[]=Dienstag{{/code}}**
95 +** Nachricht mit Antwortvorlage an alle, mit gewünschten Rückgabeformat als xml und der Antwortvorlage als serialisiertem Array**
96 +{{code language="java"}} https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=4&format=xml&freeresponses[]=Montag&freeresponses[]=Dienstag{{/code}}
110 110  
111 111  **normale Nachricht an einzelnes Fahrzeug mit Absender**
112 112  {{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test&dispatcher=Absendername