Versions Compared

Old Version 15

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version 16

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Status
colourRed
titleDEPRECATED

 

Liefert die Statusmeldungen für Nachrichten zurück.

Beschreibung

get_messagestate.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&DATEFROM=YYYYMMDD&DATETO=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate

Parameter

Parameter
Beschreibung
Typ
Hinweis
Pflicht
companyRTI Firmenschlüsselstring ja
vehicleRTI Fahrzeugschlüsselstring wird lediglich als zweites Authentifizierungsmerkmal genommenja
languageBestimmt die Ausgabesprachestring
  • kein Wert oder "deu" = Deutsch
  • "gbr" = englisch
  • "fra" = französisch
  • "ita" = italienisch
nein
sessionkeyenthaelt den Sessionkey aus "do_message.aspstringEntweder dieses Feld ist gesetzt, oder DATEFROM und DATETOja
DATEFROMDatum ab dem alle Aufträge zurückgegeben werdenstringFormat: YYYYMMDD oder DD.MM.YYYYja
DATETODatum bis zu dem alle Aufträge zurückgegeben werdenstringFormat: YYYYMMDD oder DD.MM.YYYY
Die maximale Zeitspanne beträgt 7 Tage.		ja
timefromPräzisierung des Anfangsdatums mit der ZeitstringFormat: HHMMSSnein
timetoPräzisierung des Enddatums mit der ZeitstringFormat: HHMMSSnein
datetype"insertdate" gibt alle Einträge zurück welche im abgefragten Zeitraum im Rechenzentrum verarbeitet worden sindstring nein

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

Rückgabe

Es wird eine string zurück gegeben. Ansonsten wird bei einem Fehler ein "ERROR:Beschreibung" zurückgegeben

Abfrage über Sessionkey

Metainformationen

TrennzeichenKomma ( , )
Textbegrenzernicht vorhanden
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1

Spalten

Spalte
Beschreibung
 
DATEDatum der ausgeführten AktionFormat: DD.MM.YYYY HH:MM:SS
STATEBeschreibung der Aktion 
SOURCEAuslöser der AktionPerson/Fahrzeugkennzeichen

Beispiel

Code Block
DATE,STATE,SOURCE
04.08.2010 09:48:41,Nachricht gelöscht,PND / Fahrzeugname
04.08.2010 09:43:24,Nachricht gelesen,PND / Fahrzeugname
04.08.2010 09:42:24,Zugestellt,PND / Fahrzeugname
04.08.2010 09:41:54,Zustellungsversuch,PORTAL / RTI

Rückgabe über Zeitraumabfrage

Metainformationen

TrennzeichenKomma ( , )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1

Spalten

Spalte
Beschreibung
 
DATEDatum der ausgeführten AktionFormat: DD.MM.YYYY HH:MM:SS
STATEBeschreibung der Aktion 
SOURCEAuslöser der Aktion (Person) 
SRCNAMEAuslöser der Aktion (System) 
KEYSessionkey der Nachricht 
REQUESTDATESystemzeit der AbfrageFormat: DD.MM.YYYY HH:MM:SS
INSERTDATESystemzeit der VerarbeitungFormat: DD.MM.YYYY HH:MM:SS

Beispiel

Code Block
"DATE","STATE","SOURCE","SRCNAME","KEY","REQUESTDATE","INSERTDATE"
"04.08.2010 09:48:41","Nachricht gelöscht","PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:49:23"
"04.08.2010 09:43:24","Nachricht gelesen","PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:44:10"
"04.08.2010 09:42:24","Zugestellt","PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:43:11"
"04.08.2010 09:41:54","Zustellungsversuch","PORTAL","RTI","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:42:11"

Beispielaufrufe

Code Block
titleAbfrage über SessionKey
http://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
Code Block
titleAbfrage über Zeitraum auf Basis des Insertdate
 http://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&DATEFROM=TT.MM.JJJJ&DATETO=TT.MM.JJJJ&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate
Sv translation
languageen

Status
colourRed
titleDEPRECATED

 

Return message states

Description

get_messagestate.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&DATEFROM=YYYYMMDD&DATETO=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate

Parameter

Parameter
Description
Type
Note
Mandatory
companyRTI company keystring yes
vehicleRTI vehicle keystringonly used for secondary authentificationyes
languagedefine output languagestring
  • kein Wert oder "deu" = Deutsch
  • "gbr" = englisch
  • "fra" = französisch
  • "ita" = italienisch
no
sessionkeySeesionKey from "do_message.aspstringthis field or DATEFROM and DATETO are mandatoryyes
DATEFROMbegin of requested timerangestringFormat: YYYYMMDDyes
DATETOend of requested timerangestringFormat: YYYYMMDD
Maximum time range is 7 days		yes
timefrommore precise of DATEFROMstringFormat: HHMMSSno
timetomore precise if DATETOstringFormat: HHMMSSno
datetype"insertdate" returns all states which are processed/inserted at data center in the requested timerangestring no

Return

A string will be returned. In case of error "ERROR:Description" is given.

Query by Sessionkey

Metainformations

DelimiterComma ( , )
Text Delimiternot available
Line End0x0D 0x0A (CarriageReturn LineFeed)
HeaderLine 1

Columns

Column
Description
 
DATEDate of state actionFormat: DD.MM.YYYY HH:MM:SS
STATEDescription of state action 
SOURCEsource of state actionPerson/Vehcile

Example

Code Block
DATE,STATE,SOURCE
04.08.2010 09:48:41,Nachricht gelöscht,PND / Fahrzeugname
04.08.2010 09:43:24,Nachricht gelesen,PND / Fahrzeugname
04.08.2010 09:42:24,Zugestellt,PND / Fahrzeugname
04.08.2010 09:41:54,Zustellungsversuch,PORTAL / RTI

Return via time range

Metainformations

DelimiterComma ( , )
Text DelimiterDouble Quote ( " )
Line End0x0D 0x0A (CarriageReturn LineFeed)
HeaderLine 1

Columns

Spalte
Beschreibung
 
DATEDate of state actionFormat: DD.MM.YYYY HH:MM:SS
STATEDescription of state action 
SOURCEsource of state action (Person) 
SRCNAMEsource of state action (System) 
KEYSessionkey of message 
REQUESTDATESystemtime of requestFormat: DD.MM.YYYY HH:MM:SS
INSERTDATESystemtime of insertFormat: DD.MM.YYYY HH:MM:SS

Example

Code Block
"DATE","STATE","SOURCE","SRCNAME","KEY","REQUESTDATE","INSERTDATE"
"04.08.2010 09:48:41","Nachricht gelöscht","PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:49:23"
"04.08.2010 09:43:24","Nachricht gelesen",PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:44:10"
"04.08.2010 09:42:24","Zugestellt",PND,"Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:43:11"
"04.08.2010 09:41:54","Zustellungsversuch","PORTAL","RTI","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:42:11"

Example Calls

Code Block
titleQuery by SessionKey
http://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
Code Block
titleQuery by time range based on insert date
 http://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&DATEFROM=TT.MM.JJJJ&DATETO=TT.MM.JJJJ&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate