Difference between revisions of "API referrals"
| Line 23: | Line 23: | ||
template | template | ||
stage | stage | ||
| − | + | description | |
If using a branch system, 'branch' is also required. | If using a branch system, 'branch' is also required. | ||
| + | |||
| + | Optionally, you can also add: | ||
| + | project_category | ||
| + | contact_method | ||
| + | funding_sponsor | ||
| + | contact_type | ||
| + | referrer | ||
| + | introduction_source | ||
| + | additional_org_person | ||
| + | priority | ||
| + | |||
| + | Note that, unlike the web app, referrals cannot be created with an outstanding action. To do so, call the [[API_due_contacts|due_contacts]] endpoint immediately after. | ||
Revision as of 10:20, 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
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:
client client_type date project template stage description
If using a branch system, 'branch' is also required.
Optionally, you can also add:
project_category contact_method funding_sponsor contact_type referrer introduction_source additional_org_person priority
Note that, unlike the web app, referrals cannot be created with an outstanding action. To do so, call the due_contacts endpoint immediately after.
