do_message.php
Inhaltsverzeichnis
Eine Nachricht an ein einzelnes Fahrzeug, eine Gruppe oder alle (import) senden.
Beschreibung
POST do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=Nachricht&language=deu&responsetype=2&format=xml&freeresponses[]=Montag&freeresponses[]=Dienstag&dispatcher=Absender
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| vehicle | RTI Fahrzeugschlüssel | string | entweder vehicle oder group oder import werden erwartet | (ja) |
| group | RTI Gruppenschlüssel | string | entweder vehicle oder group oder import werden erwartet | (ja) |
| import | RTI Importschlüssel | string | entweder vehicle oder group oder import werden erwartet | (ja) |
| messagetext | string | Maximale Nachrichtenlänge:
| ja | |
| responsetype | Typ der Antwortmöglichkeit | integer | 1 = keine vorgegebene Antwort (Standard) 2 = Bestätigung erwartet 3 = Ja-/Nein-Antwort erwartet 4 = vorgegebene Antworten ( für Fleet-Displays ab Version 3.0) | nein |
| freeresponses | vorgegebene Antwortmöglichkeiten | array | notwendig für responsetype = 4 | nein |
| language | Sprache | string | nur für Responsetype 2 und 3 unterstützte Parameter: deu (Standard), gbr, ndl, fra, ita | nein |
| format | Rückgabeformat | string | Format der zurückgelieferten Antwort der Schnittstelle unterstüzte Formate: csv (Standard), xml, json | nein |
| dispatcher | Absendername | string | Maximale Länge des Absendernamens: 100 Zeichen nur Android Fleet Displays | nein |
| attachments | Dateianhänge | string | UUIDs der gewünschten Dateianhänge, per Komma getrennt Die UUIDs erhalten Sie bei Hochladen der Datei über file_storage/upload_file.php oder per Abruf über file_storage/get_overview.php | nein |
Rückgabe
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 "ERROR:Beschreibung" zurückgegeben
CSV-Format
Metainformationen
| Trennzeichen | Semikolon ( ; ) |
|---|---|
| Textbegrenzer | Doppeltes Hochkomma ( " ) |
| Zeilenende | 0x0D 0x0A (CarriageReturn LineFeed) |
| Header | Zeile 1 |
Spalten
| Spalte | Beschreibung |
|---|---|
| CAR | Vehicle-Name |
| RESULT | Resultat der Aktion |
| SESSIONKEY | Sessionkey der Nachricht |
Beispiel
Rückgabe als CSV
"CAR";"RESULT";"SESSIONKEY"
"Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
"Car 2";"OK";"8a810da98bc0583af5959af0e8dde59g"
"Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""
XML Format
Rückgabe als XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE yf_domessage SYSTEM "https://map.yellowfox.de/rti/dtd/yf_domessage.dtd">
<yf_domessage>
<message>
<car>Car 1</car>
<result>ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED</result>
<sessionkey></sessionkey>
</message>
<message>
<car>Car 2</car>
<result>OK</result>
<sessionkey>8a810da98bc0583af5959af0e8dde59g</sessionkey>
</message>
<message>
<car>Car 3</car>
<result>ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3</result>
<sessionkey></sessionkey>
</message>
</yf_domessage>
JSON Format (RFC 4627)
Rückgabe als JSON
[{"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"}]
Beispielaufrufe
normale Nachricht an einzelnes Fahrzeug
https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test
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
Bestätigungsnachricht an Gruppe mit englischer Bestätigung und gewünschten Rückgabeformat als CSV
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
Ja-Nein-Nachricht an alle mit englischer Bestätigung und gewünschten Rückgabeformat als XML
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
Nachricht mit Antwortvorlage an alle, mit gewünschten Rückgabeformat als xml und der Antwortvorlage als serialisiertem Array
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
normale Nachricht an einzelnes Fahrzeug mit Absender
https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test&dispatcher=Absendername
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