Versions Compared

Old Version 22

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version 23

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

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

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring ja
vehicleRTI Fahrzeugschlüsselstringentweder vehicle oder group oder import werden erwartet(ja)
groupRTI Gruppenschlüsselstringentweder vehicle oder group oder import werden erwartet(ja)
importRTI Importschlüsselstringentweder vehicle oder group oder import werden erwartet(ja)
messagetext string

Maximale Nachrichtenlänge:

  • CE-Displays + Android Fleet: 500 Zeichen
  • Alle anderen Displays: 200 Zeichen
ja
responsetypeTyp der Antwortmöglichkeitinteger

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
freeresponsesvorgegebene Antwortmöglichkeitenserialisiertes Arraynotwendig für responsetype = 4nein
languageSprachestring

nur für Responsetype 2 und 3

unterstützte Parameter: deu (Standard), gbr, ndl, fra, ita

nein
 formatRückgabeformatstring

 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

 

CSV-Format

Metainformationen

TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1

 

Spalten

Spalte
Beschreibung
CARVehicle-Name
RESULTResultat der Aktion
SESSIONKEYSessionkey der Nachricht

 

 

Code Block
titleRückgabe als 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
titleRückgabe als 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
titleRückgabe als 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"}]

 

 

 

Beispielaufrufe

 

Code Block
titlenormale Nachricht an einzelnes Fahrzeug
http://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test
Code Block
title Bestätigungsnachricht an Gruppe mit englischer Bestätigung und gewünschten Rückgabeformat als 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
titleJa-Nein-Nachricht an alle mit englischer Bestätigung und gewünschten Rückgabeformat als 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
title Nachricht mit Antwortvorlage an alle, mit gewünschten Rückgabeformat als xml und der Antwortvorlage als serialisiertem 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

 

 

 

...