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

The user id or slug

sort optional . Must be one of: id, user_id, administration_id, offer_id, language_id, state, days, user_address, user_postal, user_city, user_country, company_name, company_boss_user_first_name, company_boss_user_last_name, company_boss_user_email, company_boss_user_phone, company_user_first_name, company_user_last_name, company_user_post, company_user_email, company_user_phone, company_address, company_postal, company_city, company_country, company_siret, internship_address, internship_postal, internship_city, internship_country, contract_type, subject, start_at, end_at, duration, nb_days, nb_hours, movement, salary, currency, breach_at, convention, created_at, updated_at.

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

Example:

To sort on internships on the fields created_at on a descending order and updated_at on a ascending order:

...&sort=-created_at,updated_at

filter optional . Must be one of: id, user_id, administration_id, offer_id, language_id, state, days, user_address, user_postal, user_city, user_country, company_name, company_boss_user_first_name, company_boss_user_last_name, company_boss_user_email, company_boss_user_phone, company_user_first_name, company_user_last_name, company_user_post, company_user_email, company_user_phone, company_address, company_postal, company_city, company_country, company_siret, internship_address, internship_postal, internship_city, internship_country, contract_type, subject, start_at, end_at, duration, nb_days, nb_hours, movement, salary, currency, breach_at, convention, created_at, updated_at, start, end, breach.

Filtering on one or more fields

Example:

To filter on internships 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)
  • administration_id (standard field)
  • offer_id (standard field)
  • language_id (standard field)
  • state (standard field)
  • days (standard field)
  • user_address (standard field)
  • user_postal (standard field)
  • user_city (standard field)
  • user_country (standard field)
  • company_name (standard field)
  • company_boss_user_first_name (standard field)
  • company_boss_user_last_name (standard field)
  • company_boss_user_email (standard field)
  • company_boss_user_phone (standard field)
  • company_user_first_name (standard field)
  • company_user_last_name (standard field)
  • company_user_post (standard field)
  • company_user_email (standard field)
  • company_user_phone (standard field)
  • company_address (standard field)
  • company_postal (standard field)
  • company_city (standard field)
  • company_country (standard field)
  • company_siret (standard field)
  • internship_address (standard field)
  • internship_postal (standard field)
  • internship_city (standard field)
  • internship_country (standard field)
  • contract_type (standard field)
  • subject (standard field)
  • start_at (standard field)
  • end_at (standard field)
  • duration (standard field)
  • nb_days (standard field)
  • nb_hours (standard field)
  • movement (standard field)
  • salary (standard field)
  • currency (standard field)
  • breach_at (standard field)
  • convention (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • start (standard field)
  • end (standard field)
  • breach (standard field)
range optional . Must be one of: id, user_id, administration_id, offer_id, language_id, state, days, user_address, user_postal, user_city, user_country, company_name, company_boss_user_first_name, company_boss_user_last_name, company_boss_user_email, company_boss_user_phone, company_user_first_name, company_user_last_name, company_user_post, company_user_email, company_user_phone, company_address, company_postal, company_city, company_country, company_siret, internship_address, internship_postal, internship_city, internship_country, contract_type, subject, start_at, end_at, duration, nb_days, nb_hours, movement, salary, currency, breach_at, convention, created_at, updated_at.

Select on a particular range

Example:

To range on internships with the updated_at field between min_value and max_value:

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

Rangeable fields:
  • id
  • user_id
  • administration_id
  • offer_id
  • language_id
  • state
  • days
  • user_address
  • user_postal
  • user_city
  • user_country
  • company_name
  • company_boss_user_first_name
  • company_boss_user_last_name
  • company_boss_user_email
  • company_boss_user_phone
  • company_user_first_name
  • company_user_last_name
  • company_user_post
  • company_user_email
  • company_user_phone
  • company_address
  • company_postal
  • company_city
  • company_country
  • company_siret
  • internship_address
  • internship_postal
  • internship_city
  • internship_country
  • contract_type
  • subject
  • start_at
  • end_at
  • duration
  • nb_days
  • nb_hours
  • movement
  • salary
  • currency
  • breach_at
  • convention
  • created_at
  • updated_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