Versions Compared

Old Version 17

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version Current

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

Status
colourBlue
titlePOST
 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[]=Montag&freeresponses[]=Dienstag&dispatcher=Absender

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öglichkeiten
serialisiertes Array
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
dispatcherAbsendernamestring

Maximale Länge des Absendernamens: 100 Zeichen

nur Android Fleet Displays

nein
attachmentsDateianhängestring

UUIDs der gewünschten Dateianhänge, per Komma getrennt

Die UUIDs erhalten Sie bei Hochladen der Datei über file_storage/upload_file.php oder per Abruf über file_storage/get_overview.php

nein
Rückgabewerte

Rückgabe

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

 

Beispielrückgabe:


CSV-Format

Metainformationen

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


Spalten

Spalte
Beschreibung
CARVehicle-Name
RESULTResultat der Aktion
SESSIONKEYSessionkey der Nachricht


Beispiel

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
languagephpxml
titleRückgabe als 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>

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

 

Beispiele

 

Beispielaufrufe


Code Block
titlenormale Nachricht an einzelnes Fahrzeug
httphttps://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


Code Block
title Bestätigungsnachricht an Gruppe mit englischer Bestätigung und gewünschten Rückgabeformat als CSV
httphttps://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 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


Code Block
title Nachricht mit Antwortvorlage an alle, mit gewünschten Rückgabeformat als xml und der Antwortvorlage als serialisiertem Array
 http https://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

 

 

[]=Montag&freeresponses[]=Dienstag


Code Block
titlenormale Nachricht an einzelnes Fahrzeug mit Absender
https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test&dispatcher=Absendername

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
 

 Sv translation
languageen
Send a message to a single vehicle, a group or to all (import).
Beschreibung
Description
 Status
colourBlue
titlePOST
 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[]=Montag&freeresponses[]=Dienstag&dispatcher=Absender
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 
 Importschlüssel
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 template
serialized 
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
dispatcherName of dispatcherstring
maximal text length: 100 signs
only android fleet displays
no
attachmentsfile attachmentsstring
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.
 
Return example:

CSV-Format
Meta informations
SeparatorSemicolon ( ; )
DelimiterDouble quote ( " )
Line break0x0D 0x0A (CarriageReturn LineFeed)
HeaderLine 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 "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>

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

 
Examples
 
Example calls

 Code Block
titlesimple message to the vehicle
httphttps://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

 Code Block
titleConfirmation message to a group with english confirmation and desired return format as CSV
httphttps://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 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

 Code Block
titleMessage with reply template to all, with desired return format as xml and the response template as a serialized array
 http https://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[]=monday&freeresponses[]=tuesday

 

 Code Block
 
 
titlesimple 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
yes