Eine Nachricht an ein einzelnes Fahrzeug, eine Gruppe oder alle (import) senden.
Beschreibung
do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=Nachricht&language=deu&responsetype=2&format=xml&freeresponses=a%3A2%3A%7Bi%3A0%3Bs%3A6%3A%22Montag%22%3Bi%3A1%3Bs%3A8%3A%22Dienstag%22%3B%7D
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 | serialisiertes 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 |
Rückgabewerte
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
Beispielrückgabe:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE yf_domessage SYSTEM "http://map.yellowfox.de/rti/dtd/yf_domessage.dtd"> <yf_domessage> <message> <car>Car 1</car> <result>OK</result> <sessionkey>8a810da98bc0583af5959af0e8dde59g</sessionkey> </message> </yf_domessage>
[{"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"}]
"CAR";"RESULT";"SESSIONKEY" "Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";"" "Car 2";"OK";"8a810da98bc0583af5959af0e8dde59g" "Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""
Beispiele
http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test
http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=2&language=gbr&format=csv
http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=3&language=gbr&format=xml
http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=4&format=xml&freeresponses=a%3A2%3A%7Bi%3A0%3Bs%3A6%3A%22Montag%22%3Bi%3A1%3Bs%3A8%3A%22Dienstag%22%3B%7D