New renovations can be created using this endpoint.
POST /renovations
{
"estate_id": "string"
}
{
"id": "string",
"estate_id": "string"
}
201 Created
This endpoint can be used to fetch a list of all renovations that are visible to you.
GET /renovations
[
{
"id": "string",
"estate_id": "string",
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"energy_efficiency_indication": "string",
"energy_efficiency_type": "string"
}
]
200 OK
This endpoint returns more information about a specific renovation.
GET /renovations/{renovation_id}
{
"id": "string",
"estate_id": "string",
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"energy_efficiency_indication": "string",
"energy_efficiency_type": "string",
"files": [
{
"id": "string",
"name": "string",
"url": "string",
"mimetype": "string"
}
]
}
200 OK
This endpoint can be used to delete renovations.
DELETE /renovations/{renovation_id}
200 OK
This endpoint returns a detailed overview of all items that were added to the renovation.
GET /renovations/{renovation_id}/overview
{
"summary": {
"estate_id": "string",
"total_subsidy_amount": "number",
"total_estimated_cost": "number",
"total_estimated_vat_cost": "number"
},
"general": [{}],
"rooms": [{}],
"roofs": [{}],
"staircases": [{}],
"derived": [{}]
}
200 OK
This endpoint returns information about the government grants that are applicable to the renovation based on the added renovation items.
GET /renovations/{renovation_id}/government-grants
{
"TECHNICAL_INSTALLATIONS": {
"total_subsidy_amount": "number",
"total_estimated_cost": "number",
"total_estimated_vat_cost": "number",
"eligible_renovation_items": [{}]
}
}
200 OK
General renovation items are items that are not linked to certain estate objects like rooms, staircases or roofs. They can be added using this endpoint.
POST /renovations/{renovation_id}/items
{
"renovation_component_type": "string",
"count": "number"
}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
201 Created
This endpoint can be used to get a list of renovation items that can be added to the renovation. This list is dependent on multiple parameters, such as the estate type the renovation was created for, the quality of the data of the estate and others. The properties root_renovation_component_type and selection_tree are the main properties used to indicate and alter the type of the renovation item. root_renovation_component_type always indicate the less specific type of the renovation item. Property selection_tree complements this with information about choices in material, quality, finishing etc. Moreover, this property also illustrates the hierarchy between the different choices that can be made. For example, when choosing for a metal hanging gutter to be added to a roof, the root_renovation_component_type would be ROOF_DRAINAGE while selection_tree would indicate the specific selected item is of the variant HANGING_GUTTER_METAL. More precisely, selection_tree would have the following form:
{
"ROOF_DRAINAGE": {
"is_selected": true,
"enum_selection_tree": {
"BOX_GUTTER": {
"is_selected": false,
"enum_selection_tree": {}
},
"HANGING_GUTTER": {
"is_selected": true,
"enum_selection_tree": {
"HANGING_GUTTER_PLASTIC": {
"is_selected": false,
"enum_selection_tree": {}
},
"HANGING_GUTTER_METAL": {
"is_selected": true,
"enum_selection_tree": {}
}
},
}
},
}
}
GET /renovations/{renovation_id}/available-items
[
{
"root_renovation_component_type": "string",
"selection_tree": [{}]
}
]
200 OK
This endpoint can be used to edit the specific renovation item.
PATCH /renovations/{renovation_id}/items/{item_id}
{
"renovation_component_type": "string",
"count": "number"
}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
200 OK
This endpoint returns a list of all general renovation items that are attached to the renovation.
GET /renovations/{renovation_id}/items
[
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
]
200 OK
This endpoint returns more detailed information about a single general renovation item.
GET /renovations/{renovation_id}/items/{item_id}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
200 OK
This endpoint can be used to delete a specific general renovation item.
DELETE /renovations/{renovation_id}/items/{item_id}
200 OK
For further context about the following endpoints to add and manage room renovation items within the renovation, consult the descriptions added to the reference for general renovation items above.
POST /renovations/{renovation_id}/rooms/{room_id}/items
{
"renovation_component_type": "string",
"count": "number"
}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
201 Created
GET /renovations/{renovation_id}/rooms/{room_id}/available-items
[
{
"root_renovation_component_type": "string",
"selection_tree": [{}]
}
]
200 OK
PATCH /renovations/{renovation_id}/rooms/{room_id}/items/{item_id}
{
"renovation_component_type": "string",
"count": "number"
}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
200 OK
GET /renovations/{renovation_id}/rooms/{room_id}/items
[
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
]
200 OK
GET /renovations/{renovation_id}/rooms/{room_id}/items/{item_id}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
200 OK
DELETE /renovations/{renovation_id}/rooms/{room_id}/items/{item_id}
200 OK
For further context about the following endpoints to add and manage roof renovation items within the renovation, consult the descriptions added to the reference for general renovation items above.
POST /renovations/{renovation_id}/roofs/{roof_id}/items
{
"renovation_component_type": "string",
"count": "number"
}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
201 Created
GET /renovations/{renovation_id}/roofs/{roof_id}/available-items
[
{
"root_renovation_component_type": "string",
"selection_tree": [{}]
}
]
200 OK
PATCH /renovations/{renovation_id}/roofs/{roof_id}/items/{item_id}
{
"renovation_component_type": "string",
"count": "number"
}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
200 OK
GET /renovations/{renovation_id}/roofs/{roof_id}/items
[
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
]
200 OK
GET /renovations/{renovation_id}/roofs/{roof_id}/items/{item_id}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
200 OK
DELETE /renovations/{renovation_id}/roofs/{roof_id}/items/{item_id}
200 OK
For further context about the following endpoints to add and manage staircase renovation items within the renovation, consult the descriptions added to the reference for general renovation items above.
POST /renovations/{renovation_id}/staircases/{staircase_id}/items
{
"renovation_component_type": "string",
"count": "number"
}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
201 Created
GET /renovations/{renovation_id}/staircases/{staircase_id}/available-items
[
{
"root_renovation_component_type": "string",
"selection_tree": [{}]
}
]
200 OK
PATCH /renovations/{renovation_id}/staircases/{staircase_id}/items/{item_id}
{
"renovation_component_type": "string",
"count": "number"
}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
200 OK
GET /renovations/{renovation_id}/staircases/{staircase_id}/items
[
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
]
200 OK
GET /renovations/{renovation_id}/staircases/{staircase_id}/items/{item_id}
{
"id": "string",
"root_renovation_component_type": "string",
"renovation_component_type": "string",
"selection_tree": [{}],
"estimated_cost": "number",
"estimated_vat_cost": "number",
"subsidy_amount": "number",
"count": "number"
}
200 OK
DELETE /renovations/{renovation_id}/staircases/{staircase_id}/items/{item_id}
200 OK
GET /renovations/{renovation_id}/report
{}
{
"id": "string",
"name": "string",
"url": "string",
"mimetype": "string"
}
200 OK