Benutzer-Werkzeuge

Webseiten-Werkzeuge


rest_api

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
Nächste ÜberarbeitungBeide Seiten der Revision
rest_api [2019/04/04 07:37] – [Abruf und Rückgabe einer E-Mail] lwsystemsrest_api [2019/10/18 12:47] – [REST API] 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#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 271: Zeile 271:
   "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.txt · Zuletzt geändert: 2023/11/02 09:56 von lwsystems