Room rate types describe the types of rate that can be set for rooms.
A unique Id for the room rate type.
A unique short code for the room rate (e.g. PN).
The date/time the room rate type was created.
A list of duration types the room rate includes; |(permanent|respite)
Flag indiciating if the this room rate should be excluded when calculating average weekly room rates (only applicable to weekly rates).
A list of the funding types the room rate includes; private, local_authority, local_authority_top_up, chc, chc_lifestyle, block_bed, dta_spot.
The date/time the room rate type was modified.
A unique name for the room rate (e.g. Private nursing).
The position of the room rate relevant to other room rates when presented.
A flag indicating if the rate can be quoted to care seekers.
The period the room rate covers;daily, weekly.
A list of the type of care the room rate covers; bariatric_care, learning_disability_care, residential, residential_dementia, nursing, nursing_dementia.
{
"_id": "662edc5a835c6a1ad9675d16",
"code": "P/R",
"created": "2024-04-28 23:31:38",
"duration_types": [
"permanent",
"respite"
],
"exclude_from_averages": false,
"funding_types": [
"private"
],
"modified": "2024-04-28 23:31:38",
"name": "Private residential",
"position": 1,
"quoted_rate": true,
"rate_period": "weekly",
"types_of_care": [
"residential"
]
}
Return a list of room rate types setup for your account on CareHQ.
['_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, code.
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 room rate type.
var roomRateTypes = apiClient.Request(
HttpMethod.Get,
"room-rate-types",
new MultiValueDict()
.Add(
"attributes",
"funding_types",
"name",
"rate_period",
"types_of_care"
)
);
<?php
$room_rate_types = $api_client->request(
'GET',
'room-rate-types',
[
'attributes'=>[
'funding_types',
'name',
'rate_period',
'types_of_care'
]
]
);
room_rate_types = api_client(
'GET',
'room-rate-types',
params={
'attributes': [
'funding_types',
'name',
'rate_period',
'types_of_care'
]
}
)
room_rate_types = api_client.request(
'GET',
'room-rate-types',
params: {
'attributes' => [
'funding_types',
'name',
'rate_period',
'types_of_care'
]
}
)
{
"item_count": 6,
"items": [
{
"_id": "662edc5a835c6a1ad9675d0c",
"funding_types": [
"local_authority",
"local_authority_top_up",
"chc",
"chc_lifestyle",
"block_bed",
"dta_spot"
],
"name": "Funded dementia",
"rate_period": "weekly",
"types_of_care": [
"residential_dementia",
"nursing_dementia"
]
},
{
"_id": "662edc5a835c6a1ad9675d0e",
"funding_types": [
"local_authority",
"local_authority_top_up",
"chc",
"chc_lifestyle",
"block_bed",
"dta_spot"
],
"name": "Funded nursing",
"rate_period": "weekly",
"types_of_care": [
"nursing"
]
},
{
"_id": "662edc5a835c6a1ad9675d10",
"funding_types": [
"local_authority",
"local_authority_top_up",
"chc",
"chc_lifestyle",
"block_bed",
"dta_spot"
],
"name": "Funded residential",
"rate_period": "weekly",
"types_of_care": [
"residential"
]
},
{
"_id": "662edc5a835c6a1ad9675d12",
"funding_types": [
"private"
],
"name": "Private dementia",
"rate_period": "weekly",
"types_of_care": [
"residential_dementia",
"nursing_dementia"
]
},
{
"_id": "662edc5a835c6a1ad9675d14",
"funding_types": [
"private"
],
"name": "Private nursing",
"rate_period": "weekly",
"types_of_care": [
"nursing"
]
},
{
"_id": "662edc5a835c6a1ad9675d16",
"funding_types": [
"private"
],
"name": "Private residential",
"rate_period": "weekly",
"types_of_care": [
"residential"
]
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
Retrieve a room rate type object.
Returns a room rate type object.
var roomRateType = apiClient.Request(
HttpMethod.Get,
$"room-rate-types/{roomRateTypeId}"
);
<?php
$room_rate_type = $api_client->request(
'GET',
'room-rate-types/' . $room_rate_type_id
);
room_rate_type = api_client('GET', f'room-rate-types/{room_rate_type_id}')
room_rate_type = api_client.request(
'GET',
"room-rate-types/#{room_rate_type_id}"
)
{
"_id": "662edc5a835c6a1ad9675d16",
"code": "P/R",
"created": "2024-04-28 23:31:38",
"duration_types": [
"permanent",
"respite"
],
"exclude_from_averages": false,
"funding_types": [
"private"
],
"modified": "2024-04-28 23:31:38",
"name": "Private residential",
"position": 1,
"quoted_rate": true,
"rate_period": "weekly",
"types_of_care": [
"residential"
]
}