パラメーター

パラメーター名 記述
search
任意

Search string

Validations:

  • Must be a String

page
任意

Page number, starting at 1

Validations:

  • Must be a number.

per_page
任意

Number of results per page to return

Validations:

  • Must be a number.

order
任意

Sort field and order, e.g. 'name DESC'

Validations:

  • Must be a String

sort
任意

Hash version of 'order' param

Validations:

  • Must be a Hash

sort[by]
任意

Field to sort the results on

Validations:

  • Must be a String

sort[order]
任意

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • Must be a String