API: External Referrals

From Charitylog Manual
Revision as of 15:14, 17 February 2020 by Msim (talk | contribs)
Jump to: navigation, search
Helpheader small.png

External Referrals are an alterative to making clients and referrals directly: they are held in a staging area, to be imported or rejected by the system administrator. This has the advantage that the caller of the API does not need to check whether the client they have is already known - the administrator can use the search tools in the GUI to prevent duplicates.

[PUT] https://api.dizions.co.uk/v2/external_referral

The org_type_id, surname and description fields must be passed as a minimum. Most optional fields are any field from the client endpoint, with 1 notable exception: project. Including project will save the user who processes the referrals from having to select it each time they import.


Multiple people can be sent in one PUT, for instance a carer and a cared for, or a client and social worker.