API referrals

From Charitylog Manual
Revision as of 10:05, 24 February 2022 by Msim (talk | contribs)
Jump to: navigation, search

Go to API overview

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


To create a referral, post to the endpoint, like this:

[POST] https://api.dizions.co.uk/v2/referrals

The body should be x-wwww-form-urlencoded, and contain the following keys and values:

- project
- template