get_messagestate.asp

Version 1.1 von YellowFox_RD am 2024/12/19 10:11

Inhaltsverzeichnis

Beschreibung
Parameter
Mögliche Nachrichtenstatus
Rückgabe
- Abfrage über Sessionkey
- Rückgabe über Zeitraumabfrage
  - Metainformationen
  - Spalten
Beispielaufrufe

DEPRECATED

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
company	RTI Firmenschlüssel	string		ja
vehicle	RTI Fahrzeugschlüssel	string	wird lediglich als zweites Authentifizierungsmerkmal genommen	ja
language	Bestimmt die Ausgabesprache	string	kein Wert oder "deu" = Deutsch "gbr" = englisch "fra" = französisch "ita" = italienisch	nein
sessionkey	enthaelt den Sessionkey aus "do_message.asp	string	Entweder dieses Feld ist gesetzt, oder DATEFROM und DATETO	ja
DATEFROM	Datum ab dem alle Aufträge zurückgegeben werden	string	Format: YYYYMMDD oder DD.MM.YYYY	ja
DATETO	Datum bis zu dem alle Aufträge zurückgegeben werden	string	Format: YYYYMMDD oder DD.MM.YYYY Die maximale Zeitspanne beträgt 7 Tage.	ja
timefrom	Präzisierung des Anfangsdatums mit der Zeit	string	Format: HHMMSS	nein
timeto	Präzisierung des Enddatums mit der Zeit	string	Format: HHMMSS	nein
datetype	"insertdate" gibt alle Einträge zurück welche im abgefragten Zeitraum im Rechenzentrum verarbeitet worden sind	string		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

Rückgabe

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

Abfrage über Sessionkey

Metainformationen

Trennzeichen	Komma ( , )
Textbegrenzer	nicht vorhanden
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1

Spalten

Spalte	Beschreibung
DATE	Datum der ausgeführten Aktion	Format: DD.MM.YYYY HH:MM:SS
STATE	Beschreibung der Aktion
SOURCE	Auslöser der Aktion	Person/Fahrzeugkennzeichen

Beispiel

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

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

Spalten

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

Beispiel

"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

Abfrage über SessionKey
https://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY

Abfrage über Zeitraum auf Basis des Insertdate
https://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