live_help Notes

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

settings Params

Param name Description
sort optional . Must be one of: id, name, description, cursus_id, skill_id, nbr_xp, slug, begin_at, duration, created_at, updated_at, campus_id.

The sort field. Sorted by id desc by default.

Example:

To sort on dashes on the fields updated_at on a descending order and campus_id on a ascending order:

...&sort=-updated_at,campus_id

filter optional . Must be one of: id, name, description, cursus_id, skill_id, nbr_xp, slug, begin_at, duration, created_at, updated_at, campus_id, future.

Filtering on one or more fields

Example:

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

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

Filterable fields:
  • id (standard field)
  • name (standard field)
  • description (standard field)
  • cursus_id (standard field)
  • skill_id (standard field)
  • nbr_xp (standard field)
  • slug (standard field)
  • begin_at (standard field)
  • duration (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • campus_id (standard field)
  • future : Return only dashes which begins in the future. Can be one of: true, false
range optional . Must be one of: id, name, description, cursus_id, skill_id, nbr_xp, slug, begin_at, duration, created_at, updated_at, campus_id.

Select on a particular range

Example:

To range on dashes with the campus_id field between min_value and max_value:

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

Rangeable fields:
  • id
  • name
  • description
  • cursus_id
  • skill_id
  • nbr_xp
  • slug
  • begin_at
  • duration
  • created_at
  • updated_at
  • campus_id
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

comments powered by <span class='logo-disqus'>Disqus</span>