live_help Notes

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

settings Params

Param name Description
user_id optional . Must be String

The user id or slug

campus_id optional . Must be String

The campus id or slug

filter optional . Must be one of: id, duration, user_id, expected_unfreezed_at, created_at, updated_at, close_id, is_free, cursus_id, campus_id, expected_unfreezed.

Filtering on one or more fields

Example:

To filter on anti grav units users with the id field matching a_value or another_value:

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

Filterable fields:
  • id (standard field)
  • duration (standard field)
  • user_id (standard field)
  • expected_unfreezed_at (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • close_id (standard field)
  • is_free (standard field)
  • cursus_id : Only return agu users with users in the given cursus. Can be one of: 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 25
  • campus_id : Only return agu users with users in the given campus. Can be one of: 1, 2, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34
  • expected_unfreezed (standard field)
range optional . Must be one of: id, duration, user_id, expected_unfreezed_at, created_at, updated_at, close_id, is_free.

Select on a particular range

Example:

To range on anti grav units users with the is_free field between min_value and max_value:

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

Rangeable fields:
  • id
  • duration
  • user_id
  • expected_unfreezed_at
  • created_at
  • updated_at
  • close_id
  • is_free
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