POST api/veranstaltungen/Find

Sucht nach übereinstimmenden Veranstaltungen

Aufruf

URL Parameter

Keine.

Parameter

Parameter zur Suchanfrage inkl.Suchfelder, Paginierung uns Sortierung

Suchanfrage
NameBeschreibungTypWeitere Informationen
Filter

Eine Liste von Suchfiltern

Auflistung von KeyValuePair

Required

Sortierung

Definiert optional einen Sortierschlüssel

string

Keine.

ErgebnisAbsteigend

Bestimmt dass das Suchergebnis absteigend sortiert wird. Standard=false

boolean

Keine.

AsMeta

boolean

Keine.

Seite

Bestimmt die aktuelle Seitenzahl bei paginierter Suche. Standard=1.

integer

Range: inclusive between 1 and 1000

Zeilen

Bestimmt die Anzahl an Datensätzen pro Zeilen bei paginierter Suche. Standard=20

integer

Range: inclusive between 1 and 20

Anfrageformat

application/json, text/json

Beispiel:
{
  "Filter": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Sortierung": "sample string 1",
  "ErgebnisAbsteigend": true,
  "AsMeta": true,
  "Seite": 4,
  "Zeilen": 5
}

Statuscodes

  • OK (200)
  • BadRequest (400)
  • InternalServerError (500)

Antwort

Beschreibung

Suchergebnis
NameBeschreibungTypWeitere Informationen
Seite

Liefert die aktuelle Seitenzahl

integer

Keine.

Zeilen

Liefert die Zeilenanzahl pro Seite

integer

Keine.

Seiten

Liefert die Anzahl verfügbarer Seiten

integer

Keine.

AnzahlTotal

Liefert die Anzahl aller Datensätze

integer

Keine.

ErsteSeite

Liefert die Adresse zur ersten Ergebnisseite

URI

Keine.

LetzteSeite

Liefert die Adresse zur letzten Ergebnisseite

URI

Keine.

VorherigeSeite

Liefert die Adresse zur vorherigen Ergebnisseite

URI

Keine.

NaechsteSeite

Liefert die Adresse zur nachsten Ergebnisseite

URI

Keine.

Ergebnisse

Liefert eine Liste der paginierten Datensätze

Auflistung von Object

Keine.

Antwortformat

application/json, text/json

Beispiel:
{
  "Seite": 1,
  "Zeilen": 2,
  "Seiten": 3,
  "AnzahlTotal": 4,
  "ErsteSeite": "http://webapihelppage5.com",
  "LetzteSeite": "http://webapihelppage6.com",
  "VorherigeSeite": "http://webapihelppage7.com",
  "NaechsteSeite": "http://webapihelppage8.com",
  "Ergebnisse": [
    {},
    {}
  ]
}