Sv translation

language	de

Liefert die Statusmeldungen für Nachrichten zurück.

Beschreibung

...

Status
colour Green
title GET
get

...

_messages.php?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&

...

start=

...

YYYYMMDDHHMMSS&

...

end=YYYYMMDDHHMMSS&filter=1,2,3&sessionkey=ABABABABABABABABABABABABABABAB&format=xml&mode=insertdate

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string

...

	ja
vehicle	RTI Fahrzeugschlüssel	string	entweder vehicle oder group oder import werden erwartet	(ja)
group	RTI Gruppenschlüssel	string	entweder vehicle oder group oder import werden erwartet	(ja)
import	RTI Importschlüssel	string	entweder vehicle oder group oder import werden erwartet	(ja)

...

start

Anfang des Abfragezeitraum

string

Format:

...

YYYYMMDDHHMMSS

ja

...

end

Ende des Abfragezeitraum

string

Format:

...

YYYYMMDDHHMMSS

Die maximale Zeitspanne beträgt 7 Tage.

ja

...


filter	Filtermöglichkeit nach Nachrichtentyp	integer	1 = Antwort erhalten 2 = Bestätigungsnachricht gesendet 3 = Display ausgeschaltet 4 = Ja/Nein Nachricht gesendet 5 = Nachricht bereits vorhanden 6 = Nachricht erhalten 7 = Nachricht gelesen 8 = Nachricht gelöscht 9 = Nachricht konnte nicht zugestellt werden 10 = Nachricht mit Antwortvorlagen gesendet 11 = Zugestellt 12 = Zustellungsversuch mehrere Filter sind mit Komma getrennt anzugeben	nein
language	Bestimmt die Ausgabesprache	string	kein Wert oder "deu" = Deutsch "gbr" = englisch "fra" = französisch "ita" = italienisch	nein
format	Rückgabeformat	string	Format der zurückgelieferten Antwort der Schnittstelle

...

unterstützte Formate: csv (Standard), xml, json

nein

...

sessionkey

Enthält den Sessionkey aus "do_message.php"

string

Entweder dieses Feld ist gesetzt, oder

...

start und

...

end	ja
mode	Abfrage nach Historydate oder Insertdate	string	Entweder historydate (standard) oder insertdate	nein

Mögliche Nachrichtenstatus

Status	Erläuterung
Zustellungsversuch	Die Nachricht hat das YellowFox Rechenzentrum verlassen
Zugestellt	Die Nachricht ist auf dem Display erfolgreich angekommen
Display ausgeschaltet	Das Display kann die Nachricht nicht empfangen, da es ausgeschaltet ist
Nachricht bereits vorhanden	Die Nachricht kann nicht erneut zugestellt werden, da diese bereits vorhanden ist
Nachricht erhalten	Es ist eine Nachricht im Portal angekommen, welche auf einem Display erstellt wurde
Nachricht gelesen	Nachricht wurde auf dem Display gelesen
Nachricht gelöscht	Nachricht wurde auf dem Display gelöscht
Nachricht konnte nicht zugestellt werden	Die Nachricht hat das Display nicht erreicht, weitere Zustellungsversuche werden nicht durchgeführt
Nachricht mit Antwortvorlagen gesendet	Die Nachricht wurde mit Antwortvorlagen versendet
Ja/Nein Nachricht gesendet	Die Nachricht wurde mit einer Ja-Nein-Option als Antwort versendet
Bestätigungsnachricht gesendet	Die Nachricht wurde mit einer Bestätigungsoption versendet
Antwort erhalten	Eine Antwort des Displays ist eingegangen

Rückgabe

Es wird standardmäßig ein CSV-String zurückgegeben, welcher zu jedem Fahrzeug die Auswertung der Nachrichten enthält. Bei fehlenden Pflichtparametern wird ein "ERROR:Beschreibung" zurückgegeben

CSV-Format

Metainformationen

Trennzeichen	Semikolon ( ; )
Textbegrenzer	Doppeltes Hochkomma ( " )
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1

...

Spalten

Spalte	Beschreibung
DATE	Datum der ausgeführten Aktion	Format: YYYY-MM-DD HH:MM:SS
STATE	Beschreibung der Aktion
SOURCE	Auslöser der Aktion (Person)
SOURCENAME	Auslöser der Aktion (System)
SESSIONKEY	Sessionkey der Nachricht
REQUESTDATE	Systemzeit der Abfrage	Format: YYYY-MM-DD HH:MM:SS
INSERTDATE	Systemzeit der Verarbeitung	Format: YYYY-MM-DD HH:MM:SS
TEXT	Inhalt der Nachricht
RTI_IDENT	RTI Ident des Fahrzeuges

Code Block

title	Rückgabe als CSV

"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
"

02.12.2016 -

2016-12-02 13:09:15";"Bestätigungsnachricht gesendet";"PORTAL";"Disponent 1";"";"

05.12.2016 -

2016-12-05 10:17:15";"

02.12.2016 -

2016-12-02 13:09:20";"Nachricht 1";"Ident1"
"

02.12.2016 -

2016-12-02 13:08:25";"Ja/Nein Nachricht gesendet";"PORTAL";"Disponent 1";"";"

05.12.2016 -

2016-12-05 10:17:15";"

02.12.2016 -

2016-12-02 13:08:15";"Frage 1?";"Ident1"
"

02.12.2016 -

2016-12-02 09:09:15";"Antwort erhalten";"PND";"Car 1";"ABABABABABABABABABABAB";"

05.12.2016 -

2016-12-05 10:17:52";"

02.12.2016 -

2016-12-02 09:09:20";"Antwort 1";"Ident1"

XML Format

Code Block

language	xml
title	Rückgabe als XML

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd">
<yf_getmessages>
    <message>

<date>02.12.2016 -

<date>2016-12-02 13:

09<

09:15</date>
        <state>Bestätigungsnachricht gesendet</state>
        <source>PORTAL</source>
        <sourcename>Disponent 1</sourcename>
        <sessionkey/>

<requestdate>05.12.2016 - 09:49<

<requestdate>2016-12-05 10:17:15</requestdate>

<insertdate>02.12.2016 -

<insertdate>2016-12-02 13:

09<

09:20</insertdate>
        <text>Nachricht 1</text>
		<rti_ident>Ident1</rti_ident>
    </message>
    <message>

<date>02.12.2016 -

<date>2016-12-02 13:

08<

08:25</date>
        <state>Ja/Nein Nachricht gesendet</state>
        <source>PORTAL</source>
        <sourcename>Disponent 1</sourcename>
        <sessionkey/>

<requestdate>05.12.2016 - 09:49<

<requestdate>2016-12-05 10:17:15</requestdate>

<insertdate>02.12.2016 -

<insertdate>2016-12-02 13:08:

08<

15</insertdate>
        <text>Frage 1?</text>
		<rti_ident>Ident1</rti_ident>
    </message>
    <message>

<date>02.12.2016 - 09:09<

<date>2016-12-02 09:09:15</date>
        <state>Antwort erhalten</state>
        <source>PND</source>
        <sourcename>Car 1</sourcename>
        <sessionkey>ABABABABABABABABABABAB</sessionkey>

<requestdate>05.12.2016 - 09:49<

<requestdate>2016-12-05 10:17:52</requestdate>

<insertdate>02.12.2016 - 09:09<

<insertdate>2016-12-02 09:09:20</insertdate>
        <text>Antwort 1</text>
		<rti_ident>Ident1</rti_ident>
    </message>
</yf_getmessages>

JSON Format (RFC 4627)

Code Block

title	Rückgabe als JSON

[
{"date":"

02.12.2016 -

2016-12-02 13:09:15","state":"Bestätigungsnachricht gesendet","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"

05.12.2016 - 09:49

2016-12-05 10:17:15","insertdate":"

02.12.2016 -

2016-12-02 13:09:20","text":"Nachricht 1","rti_ident":"Ident1"},
{"date":"

02.12.2016 -

2016-12-02 13:08:25","state":"Ja\/Nein Nachricht gesendet","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"

05.12.2016 - 09:49

2016-12-05 10:17:15","insertdate":"

02.12.2016 -

2016-12-02 13:08:15","text":"Frage 1?","rti_ident":"Ident1"},
{"date":"

02.12.2016 -

2016-12-02 09:09:15","state":"Antwort erhalten","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"

05.12.2016 - 09:49

2016-12-05 10:17:52","insertdate":"

02.12.2016 -

2016-12-02 09:09:20","text":"Antwort 1","rti_ident":"Ident1"}
]

Beispiele

Code Block

title	Abfrage über SessionKey

https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY

https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&language=deu&sessionkey=SESSION_KEY

Code Block

title	Abfrage über Zeitraum

https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&start=20161202083015&end=20161205161500&filter=1,2,4,11&format=xml&mode=insertdate

Sv translation

language	en

Returns the states of the messages.

Description

Status

colour	Green
title	GET

get_messages.php?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&datefrom=YYYYMMDD&dateto=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&filter=1,2,3&sessionkey=ABABABABABABABABABABABABABABAB&format=xml&mode=insertdate

Parameter

...

Params	Description	Type	Note	Mandatory
company	RTI company key	string		yes
vehicle	RTI vehcile key	string	vehicle or import or group parameter	(yes)
group	RTI group key	string	vehicle or import or group parameter	(yes)
import	RTI importkey	string	vehicle or import or group parameter	(yes)
start	begin of requested timerange	datestring	format: YYYYMMDDHHMMSS	yes
end	end of requested timerange	datestring	format: YYYYMMDDHHMMSS max. timerange is 7 days	yes
filter	filter the type of messages	integer	1 = answer received 2 = confirmation message sent 3 = display off 4 = yes/no message sent 5 = message already exists 6 = message received 7 = message read 8 = message deleted 9 = message could not be sent 10 = message with response templates sent 11 = delivered 12 = delivery attempt more than one filter have to separate with a comma	no
language	define output language	string	supported params: deu (standard), gbr, ndl, fra, ita	no
format	result format	string	format of the result from the interface supported formats: csv (standard), xml, json	no
sessionkey	SessionKey from "do_message.asp	string	this field or datefrom and dateto are mandatory	yes
mode	Request of historydate or insertdate	string	historydate (standard) or insertdate	no

Possible message status

State	Description
delivery attempt	The message left the YellowFox data center.
delivered	The message has arrived successfully on the display.
display off	The display can not receive the message because it is off.
message already exists	The message can not be recached, because it already exists.
message received	A message has arrived in the portal, which was created on a display.
message read	Message was read on the display.
message deleted	Message has been deleted on the display.
message could not be sent	The message has not reached the display, further delivery attempts are not carried out.
message with response templates sent	The message was sent with reply templates.
yes/no message sent	The message was sent with a yes-no option as a response.
confirmation message sent	The message was sent with a confirmation option.
answer received	A response from the display has been received.

Return

By default, a CSV string is returned which contains the evaluation for each message. If the mandatory parameters are missing, an "ERROR: Description" is returned.

CSV format

Metainformationen

Separator	Semicolon ( ; )
Delimiter	Double quote ( " )
Line break	0x0D 0x0A (CarriageReturn LineFeed)
Header	Line 1

Columns

Column	Description
DATE	date of the executed action	format: YYYY-MM-DD HH:MM:SS
STATE	description of the action
SOURCE	action trigger (person)
SOURCENAME	action trigger (system)
SESSIONKEY	sessionkey of message
REQUESTDATE	system time of request	format: YYYY-MM-DD HH:MM:SS
INSERTDATE	system time of processing	format: YYYY-MM-DD HH:MM:SS
TEXT	content of the message
RTI_IDENT	RTI Ident

Code Block

title	result as CSV

"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
""2016-12-02 13:09:15";"confirmation message sent";"PORTAL";"Disponent 1";"";"2016-12-05 10:17:15";"2016-12-02 13:09:20";"Message 1";"Ident1"
"2016-12-02 13:08:25";"yes/no message sent";"PORTAL";"Disponent 1";"";"2016-12-05 10:17:15";"2016-12-02 13:08:15";"Question 1?";"Ident1"
"2016-12-02 09:09:15";"answer received";"PND";"Car 1";"ABABABABABABABABABABAB";"2016-12-05 10:17:52";"2016-12-02 09:09:20";"Answer 1";"Ident1"

XML format

Code Block

title	result as XML

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd">
<yf_getmessages>
    <message>
        <date>2016-12-02 13:09:15</date>
        <state>confirmation message sent</state>
        <source>PORTAL</source>
        <sourcename>Disponent 1</sourcename>
        <sessionkey/>
        <requestdate>2016-12-05 10:17:15</requestdate>
        <insertdate>2016-12-02 13:09:20</insertdate>
        <text>Message 1</text>
		<rti_ident>Ident1</rti_ident>
    </message>
    <message>
        <date>2016-12-02 13:08:25</date>
        <state>yes/no message sent</state>
        <source>PORTAL</source>
        <sourcename>Disponent 1</sourcename>
        <sessionkey/>
        <requestdate>2016-12-05 10:17:15</requestdate>
        <insertdate>2016-12-02 13:08:15</insertdate>
        <text>Question 1?</text>
		<rti_ident>Ident1</rti_ident>
    </message>
    <message>
        <date>2016-12-02 09:09:15</date>
        <state>answer received</state>
        <source>PND</source>
        <sourcename>Car 1</sourcename>
        <sessionkey>ABABABABABABABABABABAB</sessionkey>
        <requestdate>2016-12-05 10:17:52</requestdate>
        <insertdate>2016-12-02 09:09:20</insertdate>
        <text>Answer 1</text>
		<rti_ident>Ident1</rti_ident>
    </message>
</yf_getmessages>

JSON Format (RFC 4627)

Code Block

title	result as JSON

[
{"date":"2016-12-02 13:09:15","state":"confirmation message sent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"2016-12-05 10:17:15","insertdate":"2016-12-02 13:09:20","text":"Message 1"},
{"date":"2016-12-02 13:08:25","state":"yes/no message sent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"2016-12-05 10:17:15","insertdate":"2016-12-02 13:08:15","text":"Question 1?"},
{"date":"2016-12-02 09:09:15","state":"answer received","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"2016-12-05 10:17:52","insertdate":"2016-12-02 09:09:20","text":"Answer 1","rti_ident":"Ident1"}]

Example call

Code Block

title	Query by SessionKey

https

Spalten

Spalte	Beschreibung
DATE	Datum der ausgeführten Aktion	Format: DD.MM.YYYY HH:MM
STATE	Beschreibung der Aktion
SOURCE	Auslöser der Aktion (Person)
SOURCENAME	Auslöser der Aktion (System)
SESSIONKEY	Sessionkey der Nachricht
REQUESTDATE	Systemzeit der Abfrage	Format: DD.MM.YYYY HH:MM
INSERTDATE	Systemzeit der Verarbeitung	Format: DD.MM.YYYY HH:MM
TEXT	Inhalt der Nachricht

Beispiele

Code Block

title	Abfrage über SessionKey

http

://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY

https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&language=deu&sessionkey=SESSION_KEY

Code Block

title

Abfrage über Zeitraum auf Basis des Insertdate

Query by time range based

https

http

://map.yellowfox.de/rti/get_

messagestate

messages.

asp

php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&

datefrom

start=

20161202

20161202083015&

dateto=05.12.2016&timefrom=083015&timeto=161500&

end=20161205161500&filter=1,2,4,11&format=xml&mode=insertdate

Page tree

Versions Compared

Old Version 11

New Version Current

Key

Beschreibung

Status
colour Green
title GET
get

Parameter

Mögliche Nachrichtenstatus

Rückgabe

CSV-Format

Metainformationen

Spalten

XML Format

JSON Format (RFC 4627)

Beispiele

Description

Parameter

Possible message status

Return

CSV format

Metainformationen

Columns

XML format

JSON Format (RFC 4627)

Example call

Spalten

Beispiele

Page tree

Page History

Versions Compared

Old Version 11

New Version Current

Key

Beschreibung

StatuscolourGreentitleGET get

Parameter

Mögliche Nachrichtenstatus

Rückgabe

CSV-Format

Metainformationen

Spalten

XML Format

JSON Format (RFC 4627)

Beispiele

Description

Parameter

Possible message status

Return

CSV format

Metainformationen

Columns

XML format

JSON Format (RFC 4627)

Example call

Spalten

Beispiele

Status
colour Green
title GET
get