Returns the states of the messages.
Description
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
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) |
datefrom | begin of requested timerange | string | format: YYYYMMDD or DD.MM.YYYY | yes |
dateto | end of requested timerange | string | format: YYYYMMDD or DD.MM.YYYY max. timerange is 7 days | yes |
timefrom | more precise of datefrom | string | format: HHMMSS | no |
timeto | more precise of dateto | string | format: HHMMSS | no |
filter | filter the type of messages | integer | 1 = answer received
| 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 |
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: DD.MM.YYYY HH:MM |
STATE | description of the action | |
SOURCE | action trigger (person) | |
SOURCENAME | action trigger (system) | |
SESSIONKEY | sessionkey of message | |
REQUESTDATE | system time of request | format: DD.MM.YYYY HH:MM |
INSERTDATE | system time of processing | format: DD.MM.YYYY HH:MM |
TEXT | content of the message |
"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT" "02.12.2016 - 13:09";"confirmation message sent";"PORTAL";"Disponent 1";"";"05.12.2016 - 10:17";"02.12.2016 - 13:09";"Message 1" "02.12.2016 - 13:08";"yes/no message sent";"PORTAL";"Disponent 1";"";"05.12.2016 - 10:17";"02.12.2016 - 13:08";"Question 1?" "02.12.2016 - 09:09";"answer received";"PND";"Car 1";"ABABABABABABABABABABAB";"05.12.2016 - 10:17";"02.12.2016 - 09:09";"Answer 1"
XML format
<?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 - 13:09</date> <state>confirmation message sent</state> <source>PORTAL</source> <sourcename>Disponent 1</sourcename> <sessionkey/> <requestdate>05.12.2016 - 09:49</requestdate> <insertdate>02.12.2016 - 13:09</insertdate> <text>Message 1</text> </message> <message> <date>02.12.2016 - 13:08</date> <state>yes/no message sent</state> <source>PORTAL</source> <sourcename>Disponent 1</sourcename> <sessionkey/> <requestdate>05.12.2016 - 09:49</requestdate> <insertdate>02.12.2016 - 13:08</insertdate> <text>Question 1?</text> </message> <message> <date>02.12.2016 - 09:09</date> <state>answer received</state> <source>PND</source> <sourcename>Car 1</sourcename> <sessionkey>ABABABABABABABABABABAB</sessionkey> <requestdate>05.12.2016 - 09:49</requestdate> <insertdate>02.12.2016 - 09:09</insertdate> <text>Answer 1</text> </message> </yf_getmessages>
JSON Format (RFC 4627)
[ {"date":"02.12.2016 - 13:09","state":"confirmation message sent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"05.12.2016 - 09:49","insertdate":"02.12.2016 - 13:09","text":"Message 1"}, {"date":"02.12.2016 - 13:08","state":"yes/no message sent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"05.12.2016 - 09:49","insertdate":"02.12.2016 - 13:08","text":"Question 1?"}, {"date":"02.12.2016 - 09:09","state":"answer received","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"05.12.2016 - 09:49","insertdate":"02.12.2016 - 09:09","text":"Answer 1"}
Example call
http://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
http://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&datefrom=20161202&dateto=05.12.2016&timefrom=083015&timeto=161500&filter=1,2,4,11&format=xml