- Created by YellowFox R&D, last modified on Dec 05, 2016
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4 Next »
You have English selected as language but this page has not been translated yet. Translate the page or view the content in the default space language below.
Display defaultLiefert 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
Parameter
Parameter | Beschreibung | Typ | Hinweis | Pflicht |
---|---|---|---|---|
company | RTI Firmenschlüssel | string | ja | |
vehicle | RTI Fahrzeugschlüssel | string | entweder vehicle oder group oder import werden erwartet | (ja) |
group | RTI Gruppenschlüssel | string | entweder vehicle oder group oder import werden erwartet | (ja) |
import | RTI Importschlüssel | string | entweder vehicle oder group oder import werden erwartet | (ja) |
filter | Typ der Antwortmöglichkeit | integer | 1 = keine vorgegebene Antwort (Standard) 2 = Bestätigung erwartet 3 = Ja-/Nein-Antwort erwartet 4 = vorgegebene Antworten ( für Fleet-Displays ab Version 3.0) | nein |
freeresponses | vorgegebene Antwortmöglichkeiten | serialisiertes Array | notwendig für responsetype = 4 | nein |
language | Sprache | string | nur für Responsetype 2 und 3 unterstützte Parameter: deu (Standard), gbr, ndl, fra, ita | nein |
format | Rückgabeformat | string | Format der zurückgelieferten Antwort der Schnittstelle unterstüzte Formate: csv (Standard), xml, json | nein
|
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 |
| 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
http://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
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
- No labels