GET /v2/patronages_reports
Return all the patronages reports
GET /v2/users/:user_id/patronages_reports
Return all the patronages reports of the given User
GET /v2/patronages/:patronage_id/patronages_reports
Return all the patronages reports of the given Patronage
GET /v2/reports/:report_id/patronages_reports
Return all the patronages reports of the given Report
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, id desc by default. MoreExample: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 MoreExample:
To filter on patronages reports with the
...&filter[id]=a_value,another_value Filterable fields:
|
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 MoreExample:
To range on patronages reports with the
...&range[validated_at]=min_value,max_value Rangeable fields:
|
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 |