do_message.php
Table of Contents
Send a message to a single vehicle, a group or to all (import).
Description
POST do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=Message&language=gbr&responsetype=2&format=xml&freeresponses[]=Montag&freeresponses[]=Dienstag&dispatcher=Absender
Parameter
| Parameter | Description | Type | Note | Mandatory |
|---|---|---|---|---|
| company | RTI company key | string | yes | |
| vehicle | RTI vehicle key | string | either vehicle, group or import parameter | (yes) |
| group | RTI group key | string | either vehicle, group or import parameter | (yes) |
| import | RTI import key | string | either vehicle, group or import parameter | (yes) |
| messagetext | string | maximal text length:
| yes | |
| responsetype | type of the response | integer | 1 = no answer given (standard) 2 = confirmation expected 3 = yes-/no-answer expected 4 = reply template (only for fleet-displays version higher 3.0) | no |
| freeresponses | reply template | array | necessary for responsetype = 4 | no |
| language | language | string | only for responsetypes 2 and 3 necessary supported params: deu (standard), gbr, ndl, fra, ita | no |
| format | format of the result | string | format of the result from the interface supported formats: csv (standard), xml, json | 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 |
Return
By 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.
CSV-Format
Meta informations
| Separator | Semicolon ( ; ) |
|---|---|
| Delimiter | Double quote ( " ) |
| Line break | 0x0D 0x0A (CarriageReturn LineFeed) |
| Header | Line 1 |
Columns
| Column | Description |
|---|---|
| CAR | Vehicle-Name |
| RESULT | Result of the action |
| SESSIONKEY | Sessionkey of the message |
Example
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";""
XML Format
Result format as 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)
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
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://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
Confirmation message to a group with english confirmation and desired return format as 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
Yes-No message to all with english confirmation and desired return format as 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
Message with reply template to all, with desired return format as xml and the response template as a serialized 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[]=monday&freeresponses[]=tuesday
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