Difference between revisions of "API external referrals"
| Line 23: | Line 23: | ||
If you want the user who imports the referral to decide, omit the "project". Any other fields from the /clients endpoint can be included, see /clients/selectable_fields | If you want the user who imports the referral to decide, omit the "project". Any other fields from the /clients endpoint can be included, see /clients/selectable_fields | ||
| − | If you are collecting external referrals from multiple sources, you can also specify a "source" attribute, so that you can distinguish them. This would typically be "1" if you only have one source. | + | If you are collecting external referrals from multiple sources, e.g. a volunteer recruitment form and a client enquiry form, you can also specify a "source" attribute, so that you can distinguish them. This would typically be "1" if you only have one source. If specifying a source, you must also specify a "referral_role", which is used by the External Referral Manager in the web application to display different fields for different people. For example, referral_role 1 might be a carer (for whom you collect a lot of details) and referral_role 2 might be one or more cared-fors (for whom you only collect basic details). |
A fuller example might look like: | A fuller example might look like: | ||
| Line 30: | Line 30: | ||
{ | { | ||
"source": "1", | "source": "1", | ||
| + | "referral_role": "1", | ||
"first_name": "Alice", | "first_name": "Alice", | ||
"surname": "Smith", | "surname": "Smith", | ||
| Line 36: | Line 37: | ||
"postcode": "HR9 7US", | "postcode": "HR9 7US", | ||
"org_type_id": 1, | "org_type_id": 1, | ||
| − | "description": "Wants help with getting | + | "description": "Wants help with getting her children to socialise more", |
"project": 7, | "project": 7, | ||
| + | }, | ||
| + | { | ||
| + | "source": "1", | ||
| + | "referral_role": "2", | ||
| + | "first_name": "Beatrice", | ||
| + | "surname": "Smith", | ||
| + | "org_type_id": 1, | ||
| + | }, | ||
| + | { | ||
| + | "source": "1", | ||
| + | "referral_role": "2", | ||
| + | "first_name": "Carl", | ||
| + | "surname": "Smith", | ||
| + | "org_type_id": 1, | ||
} | } | ||
] | ] | ||
Revision as of 14:47, 1 March 2023
These are referrals collected externally, e.g. a self-referral form on your website.
If you want an all-in-one solution, where we create the form, and call this API for you, see our Web forms. If you want your developers to create your form, or if the referrals are coming from another application, they'll need this endpoint.
As a minimum, you need a PUT to:
[PUT] https://api.dizions.co.uk/v2/external_referral
and a body encoded as x-www-form-urlencoded containing at least the attributes below:
[
{
"first_name": "Alice",
"surname": "Smith",
"org_type_id": 1,
}
]
If you want the person doing the importing to also make a referral, specify a "description" attribute, e.g. "Wants help with getting out and about more".
When creating a referral, you may want to include a "project" attribute, which will force the referral to be created in that project when it's imported. If you want the user who imports the referral to decide, omit the "project". Any other fields from the /clients endpoint can be included, see /clients/selectable_fields
If you are collecting external referrals from multiple sources, e.g. a volunteer recruitment form and a client enquiry form, you can also specify a "source" attribute, so that you can distinguish them. This would typically be "1" if you only have one source. If specifying a source, you must also specify a "referral_role", which is used by the External Referral Manager in the web application to display different fields for different people. For example, referral_role 1 might be a carer (for whom you collect a lot of details) and referral_role 2 might be one or more cared-fors (for whom you only collect basic details).
A fuller example might look like:
[
{
"source": "1",
"referral_role": "1",
"first_name": "Alice",
"surname": "Smith",
"ethnicity": "35",
"address1": "10 High Street",
"postcode": "HR9 7US",
"org_type_id": 1,
"description": "Wants help with getting her children to socialise more",
"project": 7,
},
{
"source": "1",
"referral_role": "2",
"first_name": "Beatrice",
"surname": "Smith",
"org_type_id": 1,
},
{
"source": "1",
"referral_role": "2",
"first_name": "Carl",
"surname": "Smith",
"org_type_id": 1,
}
]
