Difference between revisions of "API: External Referrals"
From Charitylog Manual
m (Rduheaume moved page External Referrals to External Referrals To The API) |
|||
| Line 1: | Line 1: | ||
[[File:helpheader_small.png|right]] | [[File:helpheader_small.png|right]] | ||
| − | External Referrals are held in a staging area, to be imported or rejected by the system administrator. | + | 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 | [PUT] https://api.dizions.co.uk/v2/external_referral | ||
Revision as of 13:25, 31 January 2020
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.
