The query part starts with '?'. See above.
The 'functions' used must be supported by the model of the addressed object.
Pagination request
For pagination add
?page[offset]=90&page[limit]=30
| Part | Meaning |
|---|---|
page[limit]=30 |
Number of results per page |
page[offset]=90 |
Starting point, for pagination |
which should be written like
?page%5Boffset%5D=90&page%5Blimit%5D=30
Each '[' and ']' has to be escaped. In curl '-g' (globoff) may be used to avoid this.
Filter request
Depending on your requested object Filter can adress several properties.
For example: 'author', 'category', 'search', 'state', 'featured'
The following requests work on get article ...
?filter[category]=12&filter[state]=1&filter[search]=joomla%20webservices
?filter[category]=12&filter[state]=1&filter[search]=joomla+webservices
?filter[tag][]=3&filter[tag][]=22&filter[tag][]=18&filter[tag]
?filter[search]=content:Magritte
Spaces in search text may be encoded with '%20' or '+'.
Ordering request
The direction is either 'ASC' or 'DESC'
The ordering does need to align to a module field name. Which may include the table abbreviation name
?list[ordering]=a.created&list[direction]=DESC
?list[ordering]=fp.ordering&list[direction]=asc