Care fund types can be created to track the remaining funds available for a service user and predict when these funds will be depleted.
A unique Id for the care fund type.
The date/time the care fund type was created.
The number of days prior to the fund being depleted to zero that notification should be sent to subscribed users.
The date/time the care fund type was created.
A unique name for the fund type (e.g. private fund).
{
"_id": "66bfb4bc9ab4e3d6eb734916",
"created": "2024-08-16 20:21:16",
"days_before_notification": 180,
"modified": "2024-08-16 20:21:16",
"name": "Self-funding reserve"
}
Return a list of care fund types.
['_id']
A list of attributes to include for fetched objects.
A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.
A filter that accepts a date/time and filters the items returned to those modified after the date/time.
A filter that accepts a date/time and filters the items returned to those modified before the date/time.
A case insensitive keyword filter applied to the following fields; name.
1
The page number to fetch.
10
The number of items to return per page.
_id
A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.
Returns a page of care fund types.
var careFundTypes = apiClient.Request(
HttpMethod.Get,
"care-fund-types",
new MultiValueDict()
.Add("attributes", "name")
);
<?php
$care_fund_types = $api_client->request(
'GET',
'care-fund-types',
['attributes'=>['name']]
);
care_fund_types = api_client(
'GET',
'care-fund-types',
params={'attributes': ['name']}
)
care_fund_types = api_client.request(
'GET',
'care-fund-types',
params: {'attributes' => ['name']}
)
{
"item_count": 1,
"items": [
{
"_id": "66bfb4bc9ab4e3d6eb734916",
"name": "Self-funding reserve"
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
Retrieve a care fund type object.
Returns a care fund type object.
var careFundType = apiClient.Request(
HttpMethod.Get,
$"care-fund-types/{careFundTypeId}"
);
<?php
$care_fund_type = $api_client->request(
'GET',
'care-fund-types/' . $care_fund_type_id
);
care_fund_type = api_client('GET', f'care-fund-types/{care_fund_type_id}')
care_fund_type = api_client.request(
'GET',
"care-fund-types/#{care_fund_type_id}"
)
{
"_id": "66bfb4bc9ab4e3d6eb734916",
"created": "2024-08-16 20:21:16",
"days_before_notification": 180,
"modified": "2024-08-16 20:21:16",
"name": "Self-funding reserve"
}