Wiki-Quellcode von do_message.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((
3 Inhaltsverzeichnis
4 )))
5
6 {{toc/}}
7
8 Eine Nachricht an ein einzelnes Fahrzeug, eine Gruppe oder alle (import) senden.
9
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
14 = Parameter =
15
16 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
17 |company|RTI Firmenschlüssel|string| |ja
18 |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
19 |group|RTI Gruppenschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
20 |import|RTI Importschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja)
21 |messagetext| |string|Maximale Nachrichtenlänge:(((
22 * CE-Displays + Android Fleet: 500 Zeichen
23 * Alle anderen Displays: 200 Zeichen
24 )))|ja
25 |responsetype|Typ der Antwortmöglichkeit|integer|1 = keine vorgegebene Antwort (Standard)
26 2 = Bestätigung erwartet
27 3 = Ja-/Nein-Antwort erwartet
28 4 = vorgegebene Antworten ( für Fleet-Displays ab Version 3.0)|nein
29 |freeresponses|vorgegebene Antwortmöglichkeiten|array|notwendig für responsetype = 4|nein
30 |language|Sprache|string|nur für Responsetype 2 und 3
31 unterstützte Parameter: deu (Standard), gbr, ndl, fra, ita|nein
32 |format|Rückgabeformat|string|Format der zurückgelieferten Antwort der Schnittstelle
33 unterstüzte Formate: csv (Standard), xml, json|nein
34 |dispatcher|Absendername|string|Maximale Länge des Absendernamens: 100 Zeichen
35 nur Android Fleet Displays|nein
36 |attachments|Dateianhänge|string|UUIDs der gewünschten Dateianhänge, per Komma getrennt
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
39 = Rückgabe =
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 == CSV-Format ==
44
45 === Metainformationen ===
46
47 |=Trennzeichen|Semikolon ( ; )
48 |=Textbegrenzer|Doppeltes Hochkomma ( " )
49 |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
50 |=Header|Zeile 1
51
52 === Spalten ===
53
54 |=Spalte|=Beschreibung
55 |CAR|Vehicle-Name
56 |RESULT|Resultat der Aktion
57 |SESSIONKEY|Sessionkey der Nachricht
58
59 === Beispiel ===
60
61 **Rückgabe als CSV**
62 {{code language="java"}}"CAR";"RESULT";"SESSIONKEY"
63 "Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
64 "Car 2";"OK";"8a810da98bc0583af5959af0e8dde59g"
65 "Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""{{/code}}
66
67 == XML Format ==
68
69 **Rückgabe als XML**
70 {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
71 <!DOCTYPE yf_domessage SYSTEM "https://map.yellowfox.de/rti/dtd/yf_domessage.dtd">
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>
88 </yf_domessage>{{/code}}
89
90 == JSON Format (RFC 4627) ==
91
92 **Rückgabe als JSON**
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
95 = Beispielaufrufe =
96
97 **normale Nachricht an einzelnes Fahrzeug**
98 {{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test
99
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
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}}**
104
105 **Ja-Nein-Nachricht an alle mit englischer Bestätigung und gewünschten Rückgabeformat als XML**
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
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}}**
110
111 **normale Nachricht an einzelnes Fahrzeug mit Absender**
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
113
114 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&dispatcher=Absendername{{/code}}
115