Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende ÜberarbeitungNächste ÜberarbeitungBeide Seiten der Revision | ||
rest_api [2018/09/21 07:31] – [Suche in einem Zeitraum] lwsystems | rest_api [2019/12/12 10:18] – [Suche in einem Zeitraum] lwsystems | ||
---|---|---|---|
Zeile 3: | Zeile 3: | ||
====== REST API ====== | ====== REST API ====== | ||
- | Das REST API bietet ausschließlich eine generelle Authentisierung ohne Zugriffssteuerung für einzelne Benutzer. | + | Das REST API bietet ausschließlich eine generelle Authentisierung ohne Zugriffssteuerung für einzelne Benutzer. Auf das API kann über das [[Rest Interface]] zugegriffen werden. |
Es dient ausschließlich dazu, Requests der [[rest_interface# | Es dient ausschließlich dazu, Requests der [[rest_interface# | ||
===== Durchführung einer Suchanfrage | ===== Durchführung einer Suchanfrage | ||
Zeile 121: | Zeile 121: | ||
==== Suche in einem Zeitraum | ==== Suche in einem Zeitraum | ||
- | < | + | < |
Hier werden die E-Mails im Zeitraum zwischen 23.08.2013 10:20 und dem 27.08.2013 um 16:05 gesucht. | Hier werden die E-Mails im Zeitraum zwischen 23.08.2013 10:20 und dem 27.08.2013 um 16:05 gesucht. | ||
Zeile 271: | Zeile 271: | ||
" | " | ||
} | } | ||
- | </ | + | </ |
+ | ===== Aufbau der Ergebnisliste ===== | ||
+ | |||
+ | Bei einer Suche wird ausschließlich auf den Index von Benno MailArchiv zugegriffen. Alle hier aufgeführten Werte entsprechen direkt dem Inhalt des Indexes, während eine E-Mail bei der Anzeige aus dem Repo gelesen und für die Anzeige gesondert geparst wird. | ||
+ | |||
+ | ==== Zeitstempel (Date) ==== | ||
+ | |||
+ | Beim Indexieren wird der Zeitstempel aus dem Date-Header in die Zeitzone UTC konvertiert und in das entsprechende Index-Feld geschrieben. Bei Anzeige einer E-Mail wird dieser Wert in die lokale Zeitzone konvertiert. | ||
+ | |||
+ | Beim direkten Zugriff auf das REST-API muss daher darauf geachtet werden, den Inhalt von //" | ||
+ | |||
+ | |||
+ | ====== Repräsentation als Array ====== | ||
Die Repräsentation dieses Suchergebnisses in einer Programmiersprache wie bspw. PHP oder Perl könnte bspw. so aussehen: | Die Repräsentation dieses Suchergebnisses in einer Programmiersprache wie bspw. PHP oder Perl könnte bspw. so aussehen: | ||
Zeile 382: | Zeile 394: | ||
], | ], | ||
' | ' | ||
- | ' | + | ' |
' | ' | ||
}, | }, |