Eine Nachricht an ein einzelnes Fahrzeug, eine Gruppe oder alle (import) senden.

Beschreibung

do_message.php?company=COMPANY_RTIKEY&vehicle&messagetext=Message&language=gbr&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	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 Importschlüssel	string	either vehicle, group or import parameter	(yes)
messagetext		string	maximal text length: CE-displays + android fleet: 500 signs all other displays: 200 signs	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	vorgegebene Antwortmöglichkeiten	serialized array	necessary for responsetype = 4	no
language	Sprache	string	only for responsetypes 2 and 3 necessary supported params: deu (standard), gbr, ndl, fra, ita	no
format	Rückgabeformat	string	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.

Return example:

Return 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>OK</result>
		<sessionkey>8a810da98bc0583af5959af0e8dde59g</sessionkey>
	</message>
</yf_domessage>

Return 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"}]

Return as CSV

"CAR";"RESULT";"SESSIONKEY"
"Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
"Car 2";"OK";"8a810da98bc0583af5959af0e8dde59g"
"Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""

Examples

simple message to the vehicle

http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test

Confirmation 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

Yes-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

Message 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

yes

Page tree

do_message.php

Beschreibung

Parameter

Return

Examples