Änderungen von Dokument do_message.php

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

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.YellowFox_RD
1 +XWiki.yf-dominic
Inhalt
... ... @@ -1,18 +1,24 @@
1 1  (% class="box" %)
2 -(((Inhaltsverzeichnis)))
2 +(((
3 +Inhaltsverzeichnis
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Eine Nachricht an ein einzelnes Fahrzeug, eine Gruppe oder alle (import) senden.
9 +
6 6  = Beschreibung =
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
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 +
8 8  = Parameter =
15 +
9 9  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
10 -|company|RTI Firmenschlüssel|string||ja
17 +|company|RTI Firmenschlüssel|string| |ja
11 11  |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
12 12  |group|RTI Gruppenschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
13 13  |import|RTI Importschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
14 -|messagetext||string|Maximale Nachrichtenlänge:
15 -(((
21 +|messagetext| |string|Maximale Nachrichtenlänge:(((
16 16  * CE-Displays + Android Fleet: 500 Zeichen
17 17  * Alle anderen Displays: 200 Zeichen
18 18  )))|ja
... ... @@ -31,10 +31,13 @@
31 31  Die UUIDs erhalten Sie bei Hochladen der Datei über file_storage/upload_file.php oder per Abruf über file_storage/get_overview.php|nein
32 32  
33 33  = 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
35 35  
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 +
36 36  == CSV-Format ==
44 +
37 37  === Metainformationen ===
46 +
38 38  |=Trennzeichen|Semikolon ( ; )
39 39  |=Textbegrenzer|Doppeltes Hochkomma ( " )
40 40  |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -41,6 +41,7 @@
41 41  |=Header|Zeile 1
42 42  
43 43  === Spalten ===
53 +
44 44  |=Spalte|=Beschreibung
45 45  |CAR|Vehicle-Name
46 46  |RESULT|Resultat der Aktion
... ... @@ -47,6 +47,7 @@
47 47  |SESSIONKEY|Sessionkey der Nachricht
48 48  
49 49  === Beispiel ===
60 +
50 50  **Rückgabe als CSV**
51 51  {{code language="java"}}"CAR";"RESULT";"SESSIONKEY"
52 52  "Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
... ... @@ -54,28 +54,30 @@
54 54  "Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""{{/code}}
55 55  
56 56  == XML Format ==
68 +
57 57  **Rückgabe als XML**
58 58  {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
59 59  <!DOCTYPE yf_domessage SYSTEM "https://map.yellowfox.de/rti/dtd/yf_domessage.dtd">
60 60  <yf_domessage>
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>
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>
76 76   </yf_domessage>{{/code}}
77 77  
78 78  == JSON Format (RFC 4627) ==
91 +
79 79  **Rückgabe als JSON**
80 80  {{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}}
81 81  
... ... @@ -86,14 +86,14 @@
86 86  
87 87  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}}
88 88  
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}}
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}}**
91 91  
92 92  **Ja-Nein-Nachricht an alle mit englischer Bestätigung und gewünschten Rückgabeformat als XML**
93 93  {{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}}
94 94  
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}}
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}}**
97 97  
98 98  **normale Nachricht an einzelnes Fahrzeug mit Absender**
99 99  {{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test&dispatcher=Absendername