Returns the states of the messages.

Description

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

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

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)

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

Query by SessionKey

https://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

Query by time range based

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

Page tree

get_messages.php