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

The user id or slug

patronage_id optional . Must be String

The patronage id

report_id optional . Must be String

The report id or slug

sort optional . Must be one of: id, user_id, begin_at, created_at, updated_at, patronage_id, report_id, validated_at.

The sort field. Sorted by created_at desc by default.

Example:

To sort on patronages reports on the fields report_id on a descending order and validated_at on a ascending order:

...&sort=-report_id,validated_at

filter optional . Must be one of: id, user_id, begin_at, created_at, updated_at, patronage_id, report_id, validated_at, future, validated.

Filtering on one or more fields

Example:

To filter on patronages reports 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)
  • begin_at (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • patronage_id (standard field)
  • report_id (standard field)
  • validated_at (standard field)
  • future : Return only patronages reports which begins in the future. Can be one of: true, false
  • validated (standard field)
range optional . Must be one of: id, user_id, begin_at, created_at, updated_at, patronage_id, report_id, validated_at.

Select on a particular range

Example:

To range on patronages reports with the validated_at field between min_value and max_value:

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

Rangeable fields:
  • id
  • user_id
  • begin_at
  • created_at
  • updated_at
  • patronage_id
  • report_id
  • validated_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

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