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
sort optional . Must be one of: id, user_id, birth_date, gender, zip_code, country, birth_city, birth_country, postal_street, postal_complement, postal_city, postal_zip_code, postal_country, contact_affiliation, contact_last_name, contact_first_name, contact_phone1, contact_phone2, max_level_memory, max_level_logic, other_information, language, meeting_date, piscine_date, created_at, updated_at, phone, email, pin, phone_country_code, hidden_phone.

The sort field. Sorted by created_at desc by default.

Example:

To sort on user candidatures on the fields phone_country_code on a descending order and hidden_phone on a ascending order:

...&sort=-phone_country_code,hidden_phone

filter optional . Must be one of: id, user_id, birth_date, gender, country, birth_country, postal_country, piscine_date, email.

Filtering on one or more fields

Example:

To filter on user candidatures 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)
  • birth_date (standard field)
  • gender (standard field)
  • country (standard field)
  • birth_country (standard field)
  • postal_country (standard field)
  • piscine_date (standard field)
  • email : .
range optional . Must be one of: id, user_id, birth_date, gender, country, birth_country, postal_country, piscine_date.

Select on a particular range

Example:

To range on user candidatures with the piscine_date field between min_value and max_value:

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

Rangeable fields:
  • id
  • user_id
  • birth_date
  • gender
  • country
  • birth_country
  • postal_country
  • piscine_date
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>