Versions Compared

Old Version 21

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.
Datum ab dem alle Aufträge zurückgegeben werden
Sv translation
languagede

Liefert die Statusmeldungen für Nachrichten zurück.

Beschreibung

Status
colourGreen
titleGET
 getget_messages.php?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&datefromstart=YYYYMMDDYYYYMMDDHHMMSS&dateto=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSSend=YYYYMMDDHHMMSS&filter=1,2,3&sessionkey=ABABABABABABABABABABABABABABAB&format=xml&mode=insertdate

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)
datefrom
startAnfang des AbfragezeitraumstringFormat:
YYYYMMDD oder DD.MM.YYYY
YYYYMMDDHHMMSSja
end
datefromDatum bis zu dem alle Aufträge zurückgegeben werden
Ende des Abfragezeitraumstring

Format:

YYYYMMDD oder DD.MM.YYYY

YYYYMMDDHHMMSS

Die maximale Zeitspanne beträgt 7 Tage.

ja
timefromPräzisierung des Anfangsdatums mit der ZeitstringFormat: HHMMSSneintimetoPräzisierung des Enddatums mit der ZeistringFormat: HHMMSSnein
filterFiltermöglichkeit nach Nachrichtentypinteger

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
languageBestimmt die Ausgabesprachestring
  • kein Wert oder "deu" = Deutsch
  • "gbr" = englisch
  • "fra" = französisch
  • "ita" = italienisch
nein
 formatRückgabeformatstring

 Format der zurückgelieferten Antwort der Schnittstelle

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

nein

 


sessionkeyEnthält den Sessionkey aus "do_message.php"stringEntweder dieses Feld ist gesetzt, oder
DATEFROM
start und
DATETO
endja

Mögliche Nachrichtenstatus

modeAbfrage nach Historydate oder InsertdatestringEntweder historydate (standard) oder insertdatenein


Mögliche Nachrichtenstatus

StatusErläuterung
StatusErläuterung
ZustellungsversuchDie Nachricht hat das YellowFox Rechenzentrum verlassen
ZugestelltDie Nachricht ist auf dem Display erfolgreich angekommen
Display ausgeschaltetDas Display kann die Nachricht nicht empfangen, da es ausgeschaltet ist
Nachricht bereits vorhandenDie Nachricht kann nicht erneut zugestellt werden, da diese bereits vorhanden ist
Nachricht erhaltenEs ist eine Nachricht im Portal angekommen, welche auf einem Display erstellt wurde
Nachricht gelesenNachricht wurde auf dem Display gelesen
Nachricht gelöschtNachricht wurde auf dem Display gelöscht
Nachricht konnte nicht zugestellt werdenDie Nachricht hat das Display nicht erreicht, weitere Zustellungsversuche werden nicht durchgeführt
Nachricht mit Antwortvorlagen gesendetDie Nachricht wurde mit Antwortvorlagen versendet
Ja/Nein Nachricht gesendetDie Nachricht wurde mit einer Ja-Nein-Option als Antwort versendet
Bestätigungsnachricht gesendetDie Nachricht wurde mit einer Bestätigungsoption versendet
Antwort erhaltenEine 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

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

Spalten

Spalte
Beschreibung
 

DATEDatum der ausgeführten AktionFormat:
DD.MM.YYYY
YYYY-MM-DD HH:MM:SS
STATEBeschreibung der Aktion
 

SOURCEAuslöser der Aktion (Person)
 

SOURCENAMEAuslöser der Aktion (System)
 

SESSIONKEYSessionkey der Nachricht
 MM.YYYY

REQUESTDATESystemzeit der AbfrageFormat:
DD.MM.YYYY
YYYY-MM-DD HH:MM:SS
INSERTDATESystemzeit der VerarbeitungFormat:
DD.
YYYY-MM-DD HH:MM:SS
TEXTInhalt der Nachricht
 

RTI_IDENTRTI Ident des Fahrzeuges


Code Blockcode
titleRü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
languagexml
titleRü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
titleRü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:492016-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:492016-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:492016-12-05 10:17:52","insertdate":"02.12.2016 -12-02 09:09:20","text":"Antwort 1","rti_ident":"Ident1"}
] 
 

Beispiele
 

 Code Block
titleAbfrage über SessionKey
httphttps://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
 Code Block
titleAbfrage über Zeitraum 
 http

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

 Code Block
titleAbfrage über Zeitraum 
https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&start=20161202083015&end=20161205161500&language=gbr&datefrom=20161202&dateto=05.12.2016&timefrom=083015&timeto=161500&filter=1,2,4,11&format=xml&mode=insertdate


 Sv translation
languageen
Returns the states of the messages.
Description
 Status
colourGreen
titleGET
 get
Liefert die Statusmeldungen für Nachrichten zurück.
Beschreibung
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
 
ParamsDescriptionTypeNoteMandatory
companyRTI company keystring
 

yes
vehicleRTI vehcile keystringvehicle or import or group parameter(yes)
groupRTI group keystringvehicle or import or group parameter(yes)
importRTI importkeystringvehicle or import or group parameter(yes)
datefrom
startbegin of requested timerange
string
datestringformat: 
 YYYYMMDD or DD.MM.YYYY
YYYYMMDDHHMMSSyes
dateto
endend of requested timerange
string
datestring
format: 
 YYYYMMDD or DD.MM.YYYY
YYYYMMDDHHMMSS
max. timerange is 7 days
yes
timefrommore precise of datefromstringformat: HHMMSSno
timetomore precise of datetostringformat: HHMMSSno
filter
filterfilter 
filter 
 the type of messagesinteger
1 = 
 Antwort erhalten
 answer received
2 =
 Bestätigungsnachricht gesendet
 confirmation message sent
3 = 
 Display ausgeschaltet
 display off
4 = 
 Ja/Nein Nachricht gesendet
 yes/no message sent
5 = 
 Nachricht bereits vorhanden
 message already exists
6 = 
 Nachricht erhalten
 message received
7 = 
 Nachricht gelesen
 message read
8 = 
 Nachricht gelöscht
message deleted
9 = 
 Nachricht konnte nicht zugestellt werden
 message could not be sent
10 = 
 Nachricht mit Antwortvorlagen gesendet
 message with response templates sent
11 = 
 Zugestelltmehrere Filter sind mit Komma getrennt anzugeben
delivered
12 = 
 Zustellungsversuch
 delivery attempt

more than one filter have to separate with a comma
"ita" = italienisch

no
languagedefine output languagestring
  • kein Wert oder "deu" = Deutsch
  • "gbr" = englisch
  • "fra" = französisch
    • supported params: deu (standard), gbr, ndl, fra, itano
     formatresult formatstring
    format of the result from the interface
    supported formats: csv (standard), xml, json
    no
     

    sessionkeySessionKey from "do_message.aspstringthis field or datefrom and dateto are mandatoryyes
    Mögliche Nachrichtenstatus
    StatusErläuterung
    ZustellungsversuchDie Nachricht hat das YellowFox Rechenzentrum verlassen
    ZugestelltDie Nachricht ist auf dem Display erfolgreich angekommen
    Display ausgeschaltetDas Display kann die Nachricht nicht empfangen, da es ausgeschaltet ist
    Nachricht bereits vorhandenDie Nachricht kann nicht erneut zugestellt werden, da diese bereits vorhanden ist
    Nachricht erhaltenEs ist eine Nachricht im Portal angekommen, welche auf einem Display erstellt wurde
    Nachricht gelesenNachricht wurde auf dem Display gelesen
    Nachricht gelöschtNachricht wurde auf dem Display gelöscht
    Nachricht konnte nicht zugestellt werdenDie Nachricht hat das Display nicht erreicht, weitere Zustellungsversuche werden nicht durchgeführt
     Nachricht mit Antwortvorlagen gesendetDie Nachricht wurde mit Antwortvorlagen versendet
    Ja/Nein Nachricht gesendetDie Nachricht wurde mit einer Ja-Nein-Option als Antwort versendet
    Bestätigungsnachricht gesendetDie Nachricht wurde mit einer Bestätigungsoption versendet
    Antwort erhaltenEine 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
    modeRequest of historydate or insertdatestringhistorydate (standard) or insertdateno
    Possible message status
    StateDescription
    delivery attemptThe message left the YellowFox data center.
    deliveredThe message has arrived successfully on the display.
    display offThe display can not receive the message because it is off.
     message already existsThe message can not be recached, because it already exists.
    message receivedA message has arrived in the portal, which was created on a display.
    message readMessage was read on the display.
    message deletedMessage has been deleted on the display.
    message could not be sentThe message has not reached the display, further delivery attempts are not carried out.
     message with response templates sentThe message was sent with reply templates.
    yes/no message sentThe message was sent with a yes-no option as a response.
    confirmation message sentThe message was sent with a confirmation option.
    answer receivedA 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
    SeparatorSemicolon ( ; )
    DelimiterDouble quote ( " )
    Line break
    TrennzeichenSemikolon ( ; )TextbegrenzerDoppeltes Hochkomma ( " )Zeilenende
    0x0D 0x0A (CarriageReturn LineFeed)
    Header
    Zeile 
    Line 1
    Spalten
    Columns
    Spalte
    Column
    Beschreibung
     
    Description

    DATE
    Datum der ausgeführten Aktion
    date of the executed actionformat: YYYY-MM-DD 
    Format: DD.MM.YYYY  
     HH:MM:SS
    STATE
    Beschreibung der Aktion 
    description of the action
    SOURCE
    Auslöser der Aktion (Person) 
    action trigger (person)
    SOURCENAME
    Auslöser der Aktion (System) 
    action trigger (system)
    SESSIONKEY
    Sessionkey der Nachricht
    sessionkey of message
    REQUESTDATE
    Systemzeit der Abfrage
    system time of requestformat: YYYY-MM-DD 
    Format: DD.MM.YYYY 
     HH:MM:SS
    INSERTDATE
    Systemzeit der Verarbeitung
    system time of processingformat: YYYY-MM-DD 
    Format: DD.MM.YYYY 
     HH:MM:SS
    TEXT
    Inhalt der Nachricht
    content of the message
    RTI_IDENTRTI Ident
     


     Code Block
    titleRückgabe als result as CSV
    "DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"TEXTRTI_IDENT"
""02.12.2016 -2016-12-02 13:09:15";"Bestätigungsnachrichtconfirmation message gesendetsent";"PORTAL";"Disponent 1";"";"05.12.2016 -2016-12-05 10:17:15";"02.12.2016 -2016-12-02 13:09:20";"NachrichtMessage 1";"Ident1"
"02.12.2016 -2016-12-02 13:08:25";"Jayes/Neinno Nachrichtmessage gesendetsent";"PORTAL";"Disponent 1";"";"05.12.2016 -2016-12-05 10:17:15";"02.12.2016 -2016-12-02 13:08:15";"FrageQuestion 1?";"Ident1"
"02.12.2016 -2016-12-02 09:09:15";"Antwortanswer erhaltenreceived";"PND";"Car 1";"ABABABABABABABABABABAB";"05.12.2016 -2016-12-05 10:17:52";"02.12.2016 -2016-12-02 09:09:20";"Antwort 1Answer 1";"Ident1"

     
    XML 
     Format
    format
     Code Block
    titleRückgabe als 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>02.12.2016 -<date>2016-12-02 13:09:09<15</date>
        <state>confirmation <state>Bestätigungsnachrichtmessage gesendet<sent</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<text>Message 1</text>/text>
		<rti_ident>Ident1</rti_ident>
    </message>
    <message>
        <date>02.12.2016 -<date>2016-12-02 13:08:08<25</date>
        <state>Ja<state>yes/Neinno Nachrichtmessage gesendet<sent</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<text>Question 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<state>answer erhalten<received</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<text>Answer 1</text>
		<rti_ident>Ident1</rti_ident>
    </message>
</yf_getmessages>


    JSON Format (RFC 4627)
     Code Block
    titleRückgabe als result as JSON
    [
{"date":"02.12.2016 -2016-12-02 13:09:15","state":"Bestätigungsnachrichtconfirmation message gesendetsent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"05.12.2016 - 09:492016-12-05 10:17:15","insertdate":"02.12.2016 -2016-12-02 13:09:20","text":"NachrichtMessage 1"},
{"date":"02.12.2016 -2016-12-02 13:08:25","state":"Ja\yes/Neinno Nachrichtmessage gesendetsent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"05.12.2016 - 09:492016-12-05 10:17:15","insertdate":"02.12.2016 -2016-12-02 13:08:15","text":"FrageQuestion 1?"},
{"date":"02.12.2016 -2016-12-02 09:09:15","state":"Antwortanswer erhaltenreceived","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"05.12.2016 - 09:49","insertdate":"02.12.2016 - 09:09","text":"Antwort 1"}

     
    Beispielaufrufe
     
    2016-12-05 10:17:52","insertdate":"2016-12-02 09:09:20","text":"Answer 1","rti_ident":"Ident1"}]

    Example call

     Code Block
    titleQuery by SessionKey
    https://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY

https
     Code Block
    titleAbfrage über SessionKey
    http://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEYphp?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&language=deu&sessionkey=SESSION_KEY

     Code Block
    titleAbfrage über Zeitraum auf Basis des InsertdateQuery by time range based
    https http://map.yellowfox.de/rti/get_messagestatemessages.aspphp?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&datefromstart=2016120220161202083015&dateto=05.12.2016&timefrom=083015&timeto=161500end=20161205161500&filter=1,2,4,11&format=xml&mode=insertdate