Filters

This document covers information about filtering result sets when querying collection endpoints

👍

TL;DR

@TODO ABOUT FILTERS

Beside the paramterization like number of results per page or the attribute the results are ordered by or the offset to start described here, the wunderbon REST API supports more complex filtering. Only Resultsets returned by a collection can be filtered. The Filters are applied on the whole collection before it is returned from the server. Only the filtered Resultsets are returned.

6464

Operators & Parameters

You can make use of different more or less complex Filters which can be applied using the Operators shown below. This legend gives an brief overview of the Operators supported for using the Filters provided.

🚧

Filter Support

Be aware that not every endpoint supports Filters. Only endpoints returning a collection Resultset supporting Filters. See the overview tables of endpoints for more details.

OperatorDescriptionExample
__eqFind column equal with value?name__eq=smith
__notNot same with given value?active__not=true
__neNegation, the opposite of equal?name__ne=smith
__ltLower than?age__lt=10
__gtGreater than?age__gt=15
__lteLower than and equal?age__lte=25
__gteGreater than and equal?age__gte=20
__likeLike with case sensitive?name__like=smith
__ilikeLike with case insensitive (Postgres)?name__ilike=smith
__notLikeOpposite of like with case sensitive?name__notLike=smith
__notILikeOpposite of like with case insensitive (Postgres)?name__notILike=smith
__inFind value which listed on given list?city__in=düsseldorf,munich,frankfurt
__notInFind value which not listed in given list?city__notIn=köln,leipzig,wuppertal
__containsFind value that contains in given list (Postgres)?name__contains=smith
__betweenFind value which between 2 given values?date__between=2015-06-18,2017-05-31
__notBetweenFind value which is not between 2 given values?date__notBetween=2015-06-18,2017-05-31

What’s Next

Continue with our guided tour. Now, we would like to tell you more about which HTTP Verbs are supported by the wunderbon API ...