Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageen

Send a message to a single vehicle, a group or to all (import).

Description

do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=Message&language=gbr&responsetype=2&format=xml&freeresponses=a%3A2%3A%7Bi%3A0%3Bs%3A6%3A%22Monday%22%3Bi%3A1%3Bs%3A8%3A%22Tuesday%22%3B%7D

Parameter

ParameterDescriptionTypeNoteMandatory
companyRTI company keystring yes
vehicleRTI vehicle keystringeither vehicle, group or import parameter(yes)
groupRTI group keystringeither vehicle, group or import parameter(yes)
importRTI import keystringeither vehicle, group or import parameter(yes)
messagetext string

maximal text length:

  • CE-displays + android fleet: 500 signs
  • all other displays: 200 signs
yes
responsetypetype of the responseinteger

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
freeresponsesreply templateserialized arraynecessary for responsetype = 4no
languagelanguagestring

only for responsetypes 2 and 3 necessary

supported params: deu (standard), gbr, ndl, fra, ita

no
 formatformat of the resultstring

format of the result from the interface

supported formats: csv (standard), xml, json

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

SeparatorSemicolon ( ; )
DelimiterDoppeltes Hochkomma Double quote ( " )
Line break0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile Line 1


Columns

Column
Description
CARVehicle-Name
RESULTResult of the action
SESSIONKEYSessionkey of the message


Example

Code Block
titleResult 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

Code Block
languagephp
titleResult format as XML
<?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>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)

Code Block
titleResult 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"}]

 

 

 

Examples

 

Code Block
titlesimple message to the vehicle
http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test
Code Block
titleConfirmation message to a group with english confirmation and desired return format as CSV
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
Code Block
titleYes-No message to all with english confirmation and desired return format as XML
 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
titleMessage with reply template to all, with desired return format as xml and the response template as a serialized array
 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