Benutzer-Werkzeuge

Webseiten-Werkzeuge


rest_api

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
rest_api [2019/04/04 09:37]
lwsystems [Abruf und Rückgabe einer E-Mail]
rest_api [2020/02/19 18:00] (aktuell)
lwsystems
Zeile 1: Zeile 1:
- 
- 
 ====== 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#​frontents|REST Frontends]] zu verarbeiten. ​ Es dient ausschließlich dazu, Requests der [[rest_interface#​frontents|REST Frontends]] zu verarbeiten. ​
 ===== Durchführung einer Suchanfrage ​ ===== ===== Durchführung einer Suchanfrage ​ =====
Zeile 121: Zeile 119:
 ==== Suche in einem Zeitraum ​ ==== ==== Suche in einem Zeitraum ​ ====
  
-<​code>?​archive=BennoContainer&​amp;​query=((Sender:​*hansen-und-meyer*)) AND (Date:​[201308231020 TO 201308271605]))</​code>​+<​code>?​archive=BennoContainer&​amp;​query=((Sender:​*hansen-und-meyer*) AND (Date:​[201308231020 TO 201308271605]))</​code>​
  
 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 269:
   "​found":​14 ​   "​found":​14 ​
 } }
-</​code> ​+</​code>​ 
 +===== 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 //"​Date"//​ in die jeweils lokale Zeitzone zu konvertieren. 
 + 
 + 
 +====== 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:
rest_api.1554363447.txt.gz · Zuletzt geändert: 2019/04/04 09:37 von lwsystems