Wiki-Quellcode von get_messagestate.asp
Zuletzt geändert von YellowFox_RD am 2025/01/20 15:37
Verstecke letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | (% class="box" %) |
| 2 | (((Inhaltsverzeichnis))) | ||
| 3 | {{toc/}} | ||
| 4 | |||
| 5 | (% class="red mark" %)DEPRECATED(%%) | ||
| 6 | |||
| 7 | Liefert die Statusmeldungen für Nachrichten zurück. | ||
| 8 | = Beschreibung = | ||
| 9 | //**get_messagestate.asp?company**=RTI_COMPANYKEY**&vehicle**=RTI_VEHICLEKEY&**language=**deu**&DATEFROM**=YYYYMMDD**&DATETO**=YYYYMMDD**&timefrom=**HHMMSS**&timeto**=HHMMSS**&datetype=**insertdate// | ||
| 10 | = Parameter = | ||
| 11 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 12 | |company|RTI Firmenschlüssel|string||ja | ||
| 13 | |vehicle|RTI Fahrzeugschlüssel|string|wird lediglich als zweites Authentifizierungsmerkmal genommen|ja | ||
| 14 | |language|Bestimmt die Ausgabesprache|string|((( | ||
| 15 | * kein Wert oder "deu" = Deutsch | ||
| 16 | * "gbr" = englisch | ||
| 17 | * "fra" = französisch | ||
| 18 | * "ita" = italienisch | ||
| 19 | )))|nein | ||
| 20 | |sessionkey|enthaelt den Sessionkey aus "do_message.asp|string|Entweder dieses Feld ist gesetzt, oder DATEFROM und DATETO|ja | ||
| 21 | |DATEFROM|Datum ab dem alle Aufträge zurückgegeben werden|string|Format: YYYYMMDD oder DD.MM.YYYY|ja | ||
| 22 | |DATETO|Datum bis zu dem alle Aufträge zurückgegeben werden|string|Format: YYYYMMDD oder DD.MM.YYYY | ||
| 23 | Die maximale Zeitspanne beträgt 7 Tage.|ja | ||
| 24 | |timefrom|Präzisierung des Anfangsdatums mit der Zeit|string|Format: HHMMSS|nein | ||
| 25 | |timeto|Präzisierung des Enddatums mit der Zeit|string|Format: HHMMSS|nein | ||
| 26 | |datetype|"insertdate" gibt alle Einträge zurück welche im abgefragten Zeitraum im Rechenzentrum verarbeitet worden sind|string||nein | ||
| 27 | |||
| 28 | = Mögliche Nachrichtenstatus = | ||
| 29 | |=Status|=Erläuterung | ||
| 30 | |Zustellungsversuch|Die Nachricht hat das YellowFox Rechenzentrum verlassen | ||
| 31 | |Zugestellt|Die Nachricht ist auf dem Display erfolgreich angekommen | ||
| 32 | |Display ausgeschaltet|Das Display kann die Nachricht nicht empfangen, da es ausgeschaltet ist | ||
| 33 | |Nachricht bereits vorhanden|Die Nachricht kann nicht erneut zugestellt werden, da diese bereits vorhanden ist | ||
| 34 | |Nachricht erhalten|Es ist eine Nachricht im Portal angekommen, welche auf einem Display erstellt wurde | ||
| 35 | |Nachricht gelesen|Nachricht wurde auf dem Display gelesen | ||
| 36 | |Nachricht gelöscht|Nachricht wurde auf dem Display gelöscht | ||
| 37 | |Nachricht konnte nicht zugestellt werden|Die Nachricht hat das Display nicht erreicht, weitere Zustellungsversuche werden nicht durchgeführt | ||
| 38 | |||
| 39 | = Rückgabe = | ||
| 40 | Es wird eine** string **zurück gegeben. Ansonsten wird bei einem Fehler ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben | ||
| 41 | == Abfrage über Sessionkey == | ||
| 42 | === Metainformationen === | ||
| 43 | |=Trennzeichen|Komma ( , ) | ||
| 44 | |=Textbegrenzer|nicht vorhanden | ||
| 45 | |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 46 | |=Header|Zeile 1 | ||
| 47 | |||
| 48 | === Spalten === | ||
| 49 | |=Spalte|=Beschreibung|= | ||
| 50 | |DATE|Datum der ausgeführten Aktion|Format: DD.MM.YYYY HH:MM:SS | ||
| 51 | |STATE|Beschreibung der Aktion| | ||
| 52 | |SOURCE|Auslöser der Aktion|Person/Fahrzeugkennzeichen | ||
| 53 | |||
| 54 | === Beispiel === | ||
| 55 | |||
| 56 | {{code language="java"}}DATE,STATE,SOURCE | ||
| 57 | 04.08.2010 09:48:41,Nachricht gelöscht,PND / Fahrzeugname | ||
| 58 | 04.08.2010 09:43:24,Nachricht gelesen,PND / Fahrzeugname | ||
| 59 | 04.08.2010 09:42:24,Zugestellt,PND / Fahrzeugname | ||
| 60 | 04.08.2010 09:41:54,Zustellungsversuch,PORTAL / RTI{{/code}} | ||
| 61 | |||
| 62 | == Rückgabe über Zeitraumabfrage == | ||
| 63 | === Metainformationen === | ||
| 64 | |=Trennzeichen|Komma ( , ) | ||
| 65 | |=Textbegrenzer|Doppeltes Hochkomma ( " ) | ||
| 66 | |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 67 | |=Header|Zeile 1 | ||
| 68 | |||
| 69 | === Spalten === | ||
| 70 | |=Spalte|=Beschreibung|= | ||
| 71 | |DATE|Datum der ausgeführten Aktion|Format: DD.MM.YYYY HH:MM:SS | ||
| 72 | |STATE|Beschreibung der Aktion| | ||
| 73 | |SOURCE|Auslöser der Aktion (Person)| | ||
| 74 | |SRCNAME|Auslöser der Aktion (System)| | ||
| 75 | |KEY|Sessionkey der Nachricht| | ||
| 76 | |REQUESTDATE|Systemzeit der Abfrage|Format: DD.MM.YYYY HH:MM:SS | ||
| 77 | |INSERTDATE|Systemzeit der Verarbeitung|Format: DD.MM.YYYY HH:MM:SS | ||
| 78 | |||
| 79 | **Beispiel** | ||
| 80 | |||
| 81 | {{code language="java"}}"DATE","STATE","SOURCE","SRCNAME","KEY","REQUESTDATE","INSERTDATE" | ||
| 82 | "04.08.2010 09:48:41","Nachricht gelöscht","PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:49:23" | ||
| 83 | "04.08.2010 09:43:24","Nachricht gelesen","PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:44:10" | ||
| 84 | "04.08.2010 09:42:24","Zugestellt","PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:43:11" | ||
| 85 | "04.08.2010 09:41:54","Zustellungsversuch","PORTAL","RTI","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:42:11"{{/code}} | ||
| 86 | |||
| 87 | = Beispielaufrufe = | ||
| 88 | **Abfrage über SessionKey** | ||
| 89 | {{code language="java"}}https://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY{{/code}} | ||
| 90 | |||
| 91 | **Abfrage über Zeitraum auf Basis des Insertdate** | ||
| 92 | {{code language="java"}}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{{/code}} | ||
| 93 |