Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

Link zu dieser Vergleichsansicht

webservice:vermittler:suche [2017/07/03 09:58] (aktuell)
admin angelegt
Zeile 1: Zeile 1:
 +====== MitarbeiterWebservice - Suche (allgemein) ======
 +
 +===== Beispiel (abstrakt) =====
 +==== Request ====
 +Fordert 100 Ergebnisse, beginnend ab dem 50ten welche im //​EnumfilterFeld//​ den Wert "​Wert1"​ oder "​Wert2"​ haben UND das //​Volltextfeld//​ enthält "​suche"​ UND das //​Volltextfeld//​ ist nicht gleich "​suche-text"​
 +<​code>​
 +POST ${path}/​${vmt}/​.../​_suche HTTP/1.1
 +...
 +X-Dio-Start:​ 50
 +X-Dio-Anzahl:​ 100
 +
 +{
 +  "​EnumfilterFeld":​ [
 +    "​Wert1",​
 +    "​Wert2"​
 +  ],
 +  "​Volltextfeld":​ [
 +    {
 +      "​Wert":​ "​suche",​
 +      "​Vergleich":​ "​enthaelt"​
 +    },
 +    {
 +      "​Wert":​ "​suche-text",​
 +      "​Vergleich":​ "​ungleich",​
 +      "​Verknuepfung":​ "​and"​
 +    }
 +  ]
 +}
 +</​code>​
 +
 +==== Response ====
 +<​code>​
 +HTTP/1.1 200 OK
 +...
 +X-Dio-Gesamtanzahl:​ 92
 +X-Dio-Start:​ 50
 +X-Dio-Anzahl:​ 42
 +
 +[ ... ]
 +</​code>​
 +
 +===== Datentypen =====
 +==== Suche ====
 +^Name^Typ^Anmerkung^
 +|Start|integer|im Header anzugeben, Suchergebnisse ab hier, default 0|
 +|Anzahl|integer|im Header anzugeben, Anzahl der Suchergebnisse,​ default 20, max 1000|
 +
 +im Body wird der konkrete Filter angeben
 +
 +==== Enumarationfilter ====
 +ArrayOf [[webservice:​vermittler#​simpletypes|EnumValue]]
 +
 +==== Volltextfilter ====
 +^Name^Typ^Anmerkung^
 +|Wert|string|Zu suchender Text|
 +|Vergleich|string|[[#​volltextvergleich|Volltextvergleich]]|
 +|Verknuepfung|string|[[#​volltextverknuepfung|Volltextverknuepfung]]|
 +
 +==== Volltextvergleich ====
 +Kann einen der folgenden Werte annehmen:
 +^Wert^
 +|gleich|
 +|ungleich|
 +|enthaelt|
 +|beginn|
 +|ende|
 +
 +==== Volltextverknuepfung ====
 +Verknüpft den Volltextfilter mit dem vorigem Volltextfilter.
 +\\ Kann einen der folgenden Werte annehmen:
 +^Wert^
 +|and|
 +|or|
 +
 +==== Suchergebnis ====
 +^Name^Typ^Anmerkung^
 +|Start|integer|wird im Header ausgeben, übergebener Wert für Start|
 +|Anzahl|integer|wird im Header ausgeben, die Anzahl der zurück gegebenen Ergebnisse|
 +|Gesamtanzahl|integer|wird im Header ausgeben, die Gesamtanzahl der passenden Ergebnisse|
 +
 +Das konkrete Ergebnis wird als Array im Body ausgegeben