Eine Nachricht an ein einzelnes Fahrzeug, eine Gruppe oder alle Send a message to a single vehicle, a group or to all (import) senden. Beschreibung. Description do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=NachrichtMessage&language=deugbr&responsetype=2&format=xml&freeresponses=a%3A2%3A%7Bi%3A0%3Bs%3A6%3A%22Montag%22%3Bi%3A1%3Bs%3A8%3A%22Dienstag%22%3B%7D[]=Montag&freeresponses[]=Dienstag&dispatcher=Absender ParameterBeschreibungTypHinweisPflicht Firmenschlüssel | ja Fahrzeugschlüsselentweder oder oder werden erwartetja Gruppenschlüsselentweder oder oder werden erwartetja Importschlüsselentweder oder oder werden erwartetja Maximale NachrichtenlängeDisplays Android Fleet ZeichenAlle anderen Displays- signs
- all other displays: 200
| ZeichenjaTyp der Antwortmöglichkeittype of the response | integer | 1 = | keine vorgegebene Antwort (Standardno answer given (standard) 2 = | Bestätigung erwartet JaNeinAntwort erwartet vorgegebene Antworten ( für Fleet-Displays ab Version reply template (only for fleet-displays version higher 3.0)
| neinvorgegebene Antwortmöglichkeiten | serialisiertes Array | reply template | array | necessary for | notwendig für neinSprachenur für Responsetype 2 und 3 only for responsetypes 2 and 3 necessary supported params | unterstützte ParameterStandardstandard), gbr, ndl, fra, ita | neinRückgabeformatformat of the result | string |
Format der zurückgelieferten Antwort der Schnittstelle format of the result from the interface supported formats | unterstüzte FormateStandardnein | RückgabewerteEs 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: | no | dispatcher | Name of dispatcher | string | maximal text length: 100 signs only android fleet displays | no | attachments | file attachments | string | UUIDs of desired file attachments, comma-separated You get these UUIDs while uploading a file via file_storage/upload_file.php or you can access them via file_storage/get_overview.php | no |
ReturnBy default, a CSV string is returned which contains the evaluation for each vehicle and the SESSIONKEY for successful dispatch. If the mandatory parameters are missing, an "ERROR: Description" is returned.
Separator | Semicolon ( ; ) |
---|
Delimiter | Double quote ( " ) |
---|
Line break | 0x0D 0x0A (CarriageReturn LineFeed) |
---|
Header | Line 1 |
---|
Columns | |
---|
CAR | Vehicle-Name | RESULT | Result of the action | SESSIONKEY | Sessionkey of the message |
Example Code Block |
---|
title | Result format as CSV |
---|
| "CAR";"RESULT";"SESSIONKEY"
"Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
"Car 2";"OK";"8a810da98bc0583af5959af0e8dde59g"
"Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""
|
Code Block |
---|
language | php |
---|
title | Rückgabe als Result format as XML |
---|
| <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE yf_domessage SYSTEM "httphttps://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>
|
Code Block |
---|
title | Rückgabe als Result format as 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"}] |
Example calls
Code Block |
---|
| "CAR";"RESULT";"SESSIONKEY"
"Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
"Car 2";"OK";"8a810da98bc0583af5959af0e8dde59g"
"Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""
|
Beispiele simple message to the vehicle |
| https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test
https | Code Block |
---|
title | normale Nachricht an einzelnes Fahrzeug |
---|
| http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY{"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&messagetext=RTI%20do_message%20test |
Code Block |
---|
title | Bestätigungsnachricht an Gruppe mit englischer Bestätigung und gewünschten Rückgabeformat als CSV | Confirmation message to a group with english confirmation and desired return format as CSV |
---|
| httpshttp://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 Block |
---|
title | Ja-Nein-Nachricht an alle mit englischer Bestätigung und gewünschten Rückgabeformat als XML | Yes-No message to all with english confirmation and desired return format as XML |
---|
| https 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 |
Code Block |
---|
title | Nachricht mit Antwortvorlage an alle, mit gewünschten Rückgabeformat als xml und der Antwortvorlage als serialisiertem Array | Message with reply template to all, with desired return format as xml and the response template as a serialized array |
---|
| https http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=4&format=xml&freeresponses[]=monday&freeresponses[]=a%3A2%3A%7Bi%3A0%3Bs%3A6%3A%22Montag%22%3Bi%3A1%3Bs%3A8%3A%22Dienstag%22%3B%7Dtuesday
|
Code Block |
---|
title | simple message to the vehicle with dispatcher |
---|
| https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test&dispatcher=name
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 |
|