Wiki-Quellcode von do_message.php
Version 1.1 von YellowFox_RD am 2024/12/19 10:11
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | (% class="box" %) | ||
2 | (((Inhaltsverzeichnis))) | ||
3 | {{toc/}} | ||
4 | |||
5 | Eine Nachricht an ein einzelnes Fahrzeug, eine Gruppe oder alle (import) senden. | ||
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 | ||
8 | = Parameter = | ||
9 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
10 | |company|RTI Firmenschlüssel|string||ja | ||
11 | |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja) | ||
12 | |group|RTI Gruppenschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja) | ||
13 | |import|RTI Importschlüssel|string|entweder vehicle oder group oder import werden erwartet|(ja) | ||
14 | |messagetext||string|Maximale Nachrichtenlänge: | ||
15 | ((( | ||
16 | * CE-Displays + Android Fleet: 500 Zeichen | ||
17 | * Alle anderen Displays: 200 Zeichen | ||
18 | )))|ja | ||
19 | |responsetype|Typ der Antwortmöglichkeit|integer|1 = keine vorgegebene Antwort (Standard) | ||
20 | 2 = Bestätigung erwartet | ||
21 | 3 = Ja-/Nein-Antwort erwartet | ||
22 | 4 = vorgegebene Antworten ( für Fleet-Displays ab Version 3.0)|nein | ||
23 | |freeresponses|vorgegebene Antwortmöglichkeiten|array|notwendig für responsetype = 4|nein | ||
24 | |language|Sprache|string|nur für Responsetype 2 und 3 | ||
25 | unterstützte Parameter: deu (Standard), gbr, ndl, fra, ita|nein | ||
26 | |format|Rückgabeformat|string|Format der zurückgelieferten Antwort der Schnittstelle | ||
27 | unterstüzte Formate: csv (Standard), xml, json|nein | ||
28 | |dispatcher|Absendername|string|Maximale Länge des Absendernamens: 100 Zeichen | ||
29 | nur Android Fleet Displays|nein | ||
30 | |attachments|Dateianhänge|string|UUIDs der gewünschten Dateianhänge, per Komma getrennt | ||
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 | |||
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 | |||
36 | == CSV-Format == | ||
37 | === Metainformationen === | ||
38 | |=Trennzeichen|Semikolon ( ; ) | ||
39 | |=Textbegrenzer|Doppeltes Hochkomma ( " ) | ||
40 | |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed) | ||
41 | |=Header|Zeile 1 | ||
42 | |||
43 | === Spalten === | ||
44 | |=Spalte|=Beschreibung | ||
45 | |CAR|Vehicle-Name | ||
46 | |RESULT|Resultat der Aktion | ||
47 | |SESSIONKEY|Sessionkey der Nachricht | ||
48 | |||
49 | === Beispiel === | ||
50 | **Rückgabe als CSV** | ||
51 | {{code language="java"}}"CAR";"RESULT";"SESSIONKEY" | ||
52 | "Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";"" | ||
53 | "Car 2";"OK";"8a810da98bc0583af5959af0e8dde59g" | ||
54 | "Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""{{/code}} | ||
55 | |||
56 | == XML Format == | ||
57 | **Rückgabe als XML** | ||
58 | {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?> | ||
59 | <!DOCTYPE yf_domessage SYSTEM "https://map.yellowfox.de/rti/dtd/yf_domessage.dtd"> | ||
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> | ||
76 | </yf_domessage>{{/code}} | ||
77 | |||
78 | == JSON Format (RFC 4627) == | ||
79 | **Rückgabe als JSON** | ||
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 | |||
82 | = Beispielaufrufe = | ||
83 | |||
84 | **normale Nachricht an einzelnes Fahrzeug** | ||
85 | {{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test | ||
86 | |||
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 | |||
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}} | ||
91 | |||
92 | **Ja-Nein-Nachricht an alle mit englischer Bestätigung und gewünschten Rückgabeformat als XML** | ||
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 | |||
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}} | ||
97 | |||
98 | **normale Nachricht an einzelnes Fahrzeug mit Absender** | ||
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 | ||
100 | |||
101 | 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}} | ||
102 |