EntwicklerAPI-Ressourcen

Suche

Die globale Suche ist das Suchfeld des Admin-Panels als Endpunkt. Sie geben einen Namen, eine E-Mail-Adresse oder eine Belegnummer ein und erhalten passende Angebote, Saisons, Veranstalter:innen, Teilnehmer:innen, Konten und Belege auf einmal.

Endpunkte

GET/searchSuche

Das Modell des Suchergebnisses

Jede Gruppe enthält Referenzen mit uuid und name (und alias, wenn der Datensatz einen hat). Den vollständigen Datensatz rufen Sie über seinen eigenen Endpunkt ab.

Name
query
Typ
string
Beschreibung
Der Suchbegriff, wie gesendet.
Name
offers
Typ
reference[]
Beschreibung
Angebote, deren Name passt.
Name
editions
Typ
reference[]
Beschreibung
Saisons, deren Name passt.
Name
hosts
Typ
reference[]
Beschreibung
Veranstalter:innen, deren Name passt.
Name
participants
Typ
reference[]
Beschreibung
Teilnehmer:innen, deren Vor- oder Nachname passt. Braucht ROLE_ADMIN und ROLE_PARTICIPANTS_ADMIN; sonst leer.
Name
accounts
Typ
reference[]
Beschreibung
Konten, deren Vorname, Nachname oder E-Mail-Adresse passt. Braucht ROLE_ADMIN; sonst leer.
Name
receipts
Typ
reference[]
Beschreibung
Belege, deren Nummer oder Rechnungsanschrift passt oder die eine Teilnehmer:in betreffen, deren Name passt. Der name der Referenz ist die Belegnummer. Braucht ROLE_ADMIN und ROLE_PARTICIPANTS_ADMIN; sonst leer.

GET/search

Suche

Durchsucht alles, was Sie sehen dürfen. Veranstalter:innen erhalten nur ihre eigenen Angebote und Veranstalter-Profile sowie die Saisons, in denen sie Angebote anlegen können. Außerhalb Ihres eigenen Mandanten wird niemand nach Name oder E-Mail-Adresse gefunden: participants und accounts sind leer, und Belege werden nur nach ihrer Nummer gefunden.

Pflichtparameter

Name
q
Typ
string
Beschreibung
Der Suchbegriff, mindestens 2 Zeichen. Ein kürzerer Begriff ergibt ein 400, ein fehlender ein 422. Findet jeden Teil eines Namens, einer E-Mail-Adresse oder einer Belegnummer, ohne Beachtung der Groß- und Kleinschreibung.

Optionale Parameter

Name
limit
Typ
integer
Beschreibung
Die höchste Zahl an Treffern je Gruppe, von 1 bis 50. Werte außerhalb dieses Bereichs werden in ihn verschoben. Der Standard ist 10.

GET/search

curl -G https://example.fepli.eu/api/search \
  -H "Authorization: Bearer $FEPLI_TOKEN" \
  --data-urlencode "q=Müller" \
  -d limit=5

Antwort

{
  "query": "Müller",
  "offers": [],
  "editions": [],
  "participants": [
    { "uuid": "0191c7b3-1f2a-7c4d-8e5f-6a7b8c9d0e06", "name": "Lena Müller" },
    { "uuid": "0191c7b3-2e3f-7a4b-9c5d-6e7f8a9b0c16", "name": "Paul Müller" }
  ],
  "accounts": [
    { "uuid": "0191c7b2-4d5e-7f60-8a1b-2c3d4e5f6a05", "name": "Anna Müller" }
  ],
  "hosts": [],
  "receipts": [
    { "uuid": "0192e1a0-7b8c-7d9e-a0f1-2b3c4d5e6f08", "name": "RE-142" }
  ]
}