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
projects_user_id optional . Must be String

The projects_user id

user_id optional . Must be String

The user id or slug

skill_id optional . Must be String

The skill id or slug

partnerships_user_id optional . Must be String

The partnerships_user id

sort optional . Must be one of: id, user_id, skill_id, experiancable_id, experiancable_type, experience, created_at, cursus_id, is_bonus.

The sort field. Sorted by created_at desc by default.

Example:

To sort on experiences on the fields cursus_id on a descending order and is_bonus on a ascending order:

...&sort=-cursus_id,is_bonus

filter optional . Must be one of: id, user_id, skill_id, experiancable_id, experiancable_type, experience, created_at, cursus_id, is_bonus.

Filtering on one or more fields

Example:

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

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

Filterable fields:
  • id (standard field)
  • user_id (standard field)
  • skill_id (standard field)
  • experiancable_id (standard field)
  • experiancable_type (standard field)
  • experience (standard field)
  • created_at (standard field)
  • cursus_id (standard field)
  • is_bonus (standard field)
range optional . Must be one of: id, user_id, skill_id, experiancable_id, experiancable_type, experience, created_at, cursus_id, is_bonus.

Select on a particular range

Example:

To range on experiences with the is_bonus field between min_value and max_value:

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

Rangeable fields:
  • id
  • user_id
  • skill_id
  • experiancable_id
  • experiancable_type
  • experience
  • created_at
  • cursus_id
  • is_bonus
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>