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.
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 collectionResultsetsupportingFilters. See the overview tables of endpoints for more details.
| Operator | Description | Example |
|---|---|---|
__eq | Find column equal with value | ?name__eq=smith |
__not | Not same with given value | ?active__not=true |
__ne | Negation, the opposite of equal | ?name__ne=smith |
__lt | Lower than | ?age__lt=10 |
__gt | Greater than | ?age__gt=15 |
__lte | Lower than and equal | ?age__lte=25 |
__gte | Greater than and equal | ?age__gte=20 |
__like | Like with case sensitive | ?name__like=smith |
__ilike | Like with case insensitive (Postgres) | ?name__ilike=smith |
__notLike | Opposite of like with case sensitive | ?name__notLike=smith |
__notILike | Opposite of like with case insensitive (Postgres) | ?name__notILike=smith |
__in | Find value which listed on given list | ?city__in=düsseldorf,munich,frankfurt |
__notIn | Find value which not listed in given list | ?city__notIn=köln,leipzig,wuppertal |
__contains | Find value that contains in given list (Postgres) | ?name__contains=smith |
__between | Find value which between 2 given values | ?date__between=2015-06-18,2017-05-31 |
__notBetween | Find value which is not between 2 given values | ?date__notBetween=2015-06-18,2017-05-31 |
Updated almost 3 years ago
Continue with our guided tour. Now, we would like to tell you more about which HTTP Verbs are supported by the wunderbon API ...