nas/todo_api
2
1
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

Improved filtering capabilities

Browse source
This commit is contained in:
Maurits van der Schee 2016-11-03 01:49:33 +01:00
commit 1f433ff42e
3 changed files with 59 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -168,6 +168,7 @@ GET http://localhost/api.php/categories?filter=name,sw,Inter
GET http://localhost/api.php/categories?filter=id,le,1
GET http://localhost/api.php/categories?filter=id,ngt,2
GET http://localhost/api.php/categories?filter=id,bt,1,1
GET http://localhost/api.php/categories?filter=categories.id,eq,1
```
Output:
@ -176,6 +177,8 @@ Output:
{"categories":{"columns":["id","name"],"records":[["1","Internet"]]}}
```
NB: You may specify table name before the field name, seperated with a dot.
### List + Filter + Satisfy
Multiple filters can be applied by using "filter[]" instead of "filter" as a parameter name. Then the parameter "satisfy" is used to indicate whether "all" (default) or "any" filter should be satisfied to lead to a match:
@ -183,6 +186,7 @@ Multiple filters can be applied by using "filter[]" instead of "filter" as a par
```
GET http://localhost/api.php/categories?filter[]=id,eq,1&filter[]=id,eq,3&satisfy=any
GET http://localhost/api.php/categories?filter[]=id,ge,1&filter[]=id,le,3&satisfy=all
GET http://localhost/api.php/categories?filter[]=id,ge,1&filter[]=id,le,3&satisfy=categories.all
GET http://localhost/api.php/categories?filter[]=id,ge,1&filter[]=id,le,3
```
@ -192,6 +196,8 @@ Output:
{"categories":{"columns":["id","name"],"records":[["1","Internet"],["3","Web development"]]}}
```
NB: You may specify "satisfy=categories.all,posts.any" if you want to mix "and" and "or" for different tables.
### List + Column selection
By default all columns are selected. With the "columns" parameter you can select specific columns. Multiple columns should be comma separated. An asterisk ("*") may be used as a wildcard to indicate "all columns":