Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description

Ordering supported

Anchor
sort_id
sort_id

id

sort results by entity id

asc | ascending
desc | descending

Anchor
sort_name
sort_name

name

sort results by entity name

asc | ascending
desc | descending

Anchor
sort_countitems
sort_countitems

countitems

sort results by number of items contained

asc | ascending
desc | descending

...

Controlling results:

Parameter

Description

Default

Example

_start

position of the first entity to return

0 (first)

_start=5 to list 6th item and onwards

_page

page of data to display

0 (first)

_page=2, to display second page with query results

_perpage

number of results to show on each page

0 (all)

_perpage=10 to display 10 results per page

_limit

maximum number of entities to return

0 (all)

_limit=50

_sort

the sort order to return entities in
should be comma separated list of field names
suffix determines ordering
suffixes: _asc, _ascending, _desc, _descending

ascending default

_sort=name
_sort=name,email_desc,lastname_desc

...