Objekt-Filter

Standardmäßig erhalten Sie beim Auflisten von Objekten (in der Regel GET-Request gegen die Basis-URL des Objektes) alle für den aktuellen Kunden oder Reseller relevanten Objekte zurück.

Dies kann insbesondere bei Resellern jedoch schnell unübersichtlich werden. Deshalb erlauben die meisten Endpunkte eine Filterung anhand von bestimmten Attributen. Welche das sind, wird in der jeweiligen Objektdokumentation aufgelistet.

Filter werden per URL-Parameter übergeben und haben stets die gleiche Form: filter[ATTRIBUT]=WERT.

Wünschen Sie also eine Liste aller API-Objekte vom Typen OBJEKT, die ein Attribut ATTRIBUT mit dem Wert WERT haben, würden Sie die folgende URL verwenden:

https://api.variomedia.de/OBJEKT?filter[ATTRIBUT]=WERT

Sie können mehrere WERTe für ATTRIBUT angeben indem sie entweder mehrere URL-Parameter übergeben (die Standardgemäß mit &-Zeichen getrennt werden):

?filter[ATTRIBUT]=WERT_1&filter[ATTRIBUT]=WERT_2

Oder indem Sie die Werte mit Kommas trennen:

?filter[ATTRIBUT]=WERT_1,WERT_2

In beiden Fällen wird der Filter als ein logisches Oder interpretiert. ATTRIBUT darf also sowohl WERT_1, als auch WERT_2 sein.

Falls Sie Filter für mehrere unterschiedliche Attribute anwenden, werden die Filter als logisches Und angewendet.

Zum Beispiel:

?filter[domain]=domain1.de,domain2.de&filter[package_id]=1,2

Liefert eine Liste für die Domains domain1.de und domain2.de, aber nur falls sie in den Paketen 1 oder 2 liegen.