Gets scheme referral based on url

get https://{tenant}.rubixx.app/api/v2/supportschemes/{supportSchemeReference}/referrals/{referralReference}

Sample Request:

GET /api/v2.0/supportschemes/SP1000000004/referrals/REF1000000000

{
     "referralId": "0cf00b4b-8b59-4e45-8412-fc16ed3e67e4",
     "reference": "REF1000000000",
     "description": "Fred Smith",
     "person": "Freddie Smith",
     "source": "Local Authority",
     "referralDate": "29/01/2024",
     "status": "Live",
     "inactive": false,
     "schemeReference": "SP0000000004"             
}

Required Permission(s): SupportPlans.View

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://.rubixx.app/api/v2/supportschemes/supportSchemeReference/referrals/referralReference \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200On Success with the paginated collection of Support Scheme Referrals

400If the request is malformed or incorrect

401If the supplied token is not correct

403If the provided bearer token cannot perform the current request due to a lack of permissions

404If the requested resource cannot be found

500An internal server error