API Reference
These docs are for v2.3. Click to read the latest docs for v3.0.

Creates new referral for support scheme with given information based on payload

Sample Request:

POST /api/v2.0/supportschemes/SP1000000004/referrals

Example Payload:
{           
    "description": "Test purpose referral",
    "personReference": "P1000000007",
    "referralSource": "Local Authority",
    "referralDate": "01/06/2024"    
}

This endpoint requires all data to be in the body of the request
Status is Live
Inactive status is false

Requirements
"description"         Description must be set.  
"personReference"     Person reference must be set.
"referralSource"      Referral Source must be set.
"referralDate"        Referral date must be set and must be in DD/MM/YYYY format.

Required Permission(s): SupportPlans.EditSupportSchemes

Log in to see full request history
Path Params
string
required

Reference of the Support Scheme.

Body Params

Information of the new scheme referral.

string
required
length between 1 and 50
string
required
length ≥ 1
string
required
length ≥ 1
string
required
length ≥ 1
Responses
201

On Success

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json