Difference between revisions of "API referrals"
From Charitylog Manual
| Line 3: | Line 3: | ||
These are a groups of cohesive actions. These are typically called 'cases' in the web application. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API. | These are a groups of cohesive actions. These are typically called 'cases' in the web application. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API. | ||
| − | + | Typically, you might get referrals with at least a project and date filter, like this: | |
| + | |||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/referrals/date/2022-01-01,2022-12-31/project/1;2;3 | ||
| + | |||
| + | The filter 'date' is the new referral date, i.e. the date of the first done_contact on the referral. If you want all referrals with a done_contact during the date range, use 'date_active', like this: | ||
| + | |||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/referrals/date_active/2022-01-01,2022-12-31/project/1;2;3 | ||
Revision as of 09:55, 24 February 2022
These are a groups of cohesive actions. These are typically called 'cases' in the web application. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API.
Typically, you might get referrals with at least a project and date filter, like this:
[GET] https://api.dizions.co.uk/v2/referrals/date/2022-01-01,2022-12-31/project/1;2;3
The filter 'date' is the new referral date, i.e. the date of the first done_contact on the referral. If you want all referrals with a done_contact during the date range, use 'date_active', like this:
[GET] https://api.dizions.co.uk/v2/referrals/date_active/2022-01-01,2022-12-31/project/1;2;3
