Skip to content

Constant Parameters

ghost202 edited this page Apr 18, 2017 · 7 revisions

order_by

Parameters (String column, String direction) or (String "random")

Default id,asc

Example: ?order_by=id,desc, ?order_by=random


group_by

Parameters (String groups)

Default -

Example: ?group_by=id,name,....


limit

Parameters (Integer limit or String 'unlimited')

Default 15

Example ?limit=5, ?limit=unlimited


page

Parameters (Integer page)

Default 1

Example ?page=3


columns

select columns

Parameters (String columns)

Default *

Examples

  • ?columns=name,age,id
  • ?columns=*,city.id,city.name,country.name

includes

Eager Loading.

Parameters (String includes)

Default []

Example ?includes=city,country,town


appends

This will add the given values to Model's appends property as dynamically https://laravel.com/docs/5.3/eloquent-serialization#appending-values-to-json

Parameters (String appends)

Default []

Examples

  • ?appends=is_admin,balance