live_help Notes

assignment This action requires one of theses roles: Basic staff
chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
cursus_id optional . Must be String

The cursus id or slug

sort optional . Must be one of: id, lvl, xp, cursus_id, created_at.

The sort field. Sorted by created_at desc, id desc by default.

Example:

To sort on levels on the fields cursus_id on a descending order and created_at on a ascending order:

...&sort=-cursus_id,created_at

filter optional . Must be one of: id, lvl, xp, cursus_id, created_at.

Filtering on one or more fields

Example:

To filter on levels with the id field matching a_value or another_value:

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • lvl (standard field)
  • xp (standard field)
  • cursus_id (standard field)
  • created_at (standard field)
range optional . Must be one of: id, lvl, xp, cursus_id, created_at.

Select on a particular range

Example:

To range on levels with the created_at field between min_value and max_value:

...&range[created_at]=min_value,max_value

Rangeable fields:
  • id
  • lvl
  • xp
  • cursus_id
  • created_at
page optional . Must be a Hash

The pagination params, as a hash

page[number] optional . Must be Fixnum

The current page

page[size] optional . Must be Fixnum

The number of items per page, defaults to 30, maximum 100