) |
| Content-Type\* | string | application/json |
## Haal wws-punten ophalen voor een woonruimte die een zelfstandige woning vormt, op basis van de regels van versie 01-01-2025
`POST` `https://api.altum.ai/wws/01012025`
#### Request Body
| Veld | Type | Toegestane Waarden & Beschrijving |
| --------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `house_type` | String | Specificeert het woningtype. Moet een van de volgende zijn: `Eengezinswoning`, `Meergezinswoning`, `Duplexwoning`. |
| `rooms` | Array van Objects | Lijst van primaire leefruimtes (slaapkamers, woonkamers) en andere secundaire ruimtes (gangen, etc.). |
| `rooms[].type_of_room` | String | `'room'` voor primaire ruimtes (1 punt/m²) of `'other'` voor secundaire ruimtes (0.75 punten/m²). |
| `rooms[].surface_area` | Float | Oppervlakte van de ruimte in vierkante meters (m²). |
| `rooms[].shared_addresses` | Integer | Aantal adressen dat deze ruimte deelt. `1` voor een privéruimte. |
| `rooms[].heated` | Boolean | `true` als de ruimte wordt verwarmd, anders `false`. |
| `rooms[].cooled` | Boolean | `true` als de ruimte mechanische koeling heeft, anders `false`. |
| `rooms[].attic_without_fixed_staircase` | Boolean | `true` als de ruimte een zolder is die alleen via een vlizotrap bereikbaar is. Dit kan leiden tot een puntenaftrek. |
| `kitchen` | Array van Objects | Lijst van keukenruimtes. |
| `kitchen[].type_of_room` | String | `'room'` of `'other'`. Bepaalt de basiswaarde voor de oppervlaktepunten. |
| `kitchen[].open_kitchen` | Boolean | `true` als het een open keuken is, wat de punten voor verwarming beïnvloedt. |
| `kitchen[].surface_area` | Float | Oppervlakte van de keuken in m². |
| `kitchen[].countertop_length` | Float | Lengte van het aanrechtblad in meters. Wordt gebruikt om de limiet voor punten van keukenvoorzieningen te bepalen. |
| `kitchen[].shared_addresses` | Integer | Aantal adressen dat de keuken deelt. `1` voor privé. |
| `kitchen[].heated` | Boolean | `true` als de keuken wordt verwarmd. |
| `kitchen[].cooled` | Boolean | `true` als de keuken wordt gekoeld. |
| `kitchen[].kitchen_features` | Object | Bevat boolean/integer vlaggen voor elke voorziening. `1` voor aanwezig, `0` voor afwezig. Voorzieningen zijn o.a.: `extractor_system`, `induction_hob`, `ceramic_hob`, `gas_hob`, `refrigerator`, `freezer`, `oven_electric`, `oven_gas`, `microwave`, `dishwasher`, `extra_cupboard_space_per_60cm`, `one_hand_mixer_tap`, `one_hand_mixer_tap_with_boiling_function`, `thermostatic_mixer_tap`, `thermostatic_mixer_tap_with_boiling_function`. |
| `parking` | Array van Objects | Lijst van bijbehorende parkeerplaatsen. |
| `parking[].parking_type` | Integer | `1`: Privégarage/carport. `2`: Gemeenschappelijke overdekte parkeerplaats. `3`: Gemeenschappelijke open parkeerplaats. |
| `parking[].surface_area` | Float | Oppervlakte in m². **Alleen vereist voor `parking_type: 1`**. |
| `parking[].shared_addresses` | Integer | Aantal adressen dat de parkeerplaats deelt. |
| `parking[].charging_station` | Boolean | `true` als er een privé of gedeeld oplaadpunt voor een EV aanwezig is. |
| `sanitary` | Array van Objects | Lijst van badkamers of doucheruimtes. |
| `sanitary[].type_of_room` | String | `'room'` of `'other'`. |
| `sanitary[].surface_area` | Float | Oppervlakte van de sanitaire ruimte in m². |
| `sanitary[].heated` | Boolean | `true` als de ruimte wordt verwarmd. |
| `sanitary[].shower_facility` | String | Moet een van de volgende zijn: `'shower'`, `'bath'`, `'shower/bath'`. |
| `sanitary[].toilet` | Integer | Aantal standaard toiletten in deze sanitaire ruimte. |
| `sanitary[].wall_hung_toilet` | Integer | Aantal wandclosetten in deze sanitaire ruimte. |
| `sanitary[].shared_addresses` | Integer | Aantal adressen dat de ruimte deelt. `1` voor privé. |
| `sanitary[].sanitary_features` | Object | Bevat boolean/integer vlaggen voor voorzieningen zoals: `washbasin`, `multi_person_washbasin`, `cupboard_space`, `power_outlet`, `build_in_cupboard`, `complete_separation_of_shower`, `bath_with_bubble_function`, `one_hand_mixer_tap`, `thermostatic_mixer_tap`, `towel_radiator`. |
| `outdoor` | Array van Objects | Lijst van privé of gemeenschappelijke buitenruimtes. Een lege lijst `[]` resulteert in -5 punten aftrek. |
| `outdoor[].surface_area` | Float | Oppervlakte van de buitenruimte in m². |
| `outdoor[].shared_addresses` | Integer | Aantal adressen dat de ruimte deelt. `1` voor privé. |
| `toilet` | Array van Objects | Lijst van aparte toiletruimtes (niet in een badkamer). |
| `toilet[].type_of_room` | String | `'room'` of `'other'`. |
| `toilet[].surface_area` | Float | Oppervlakte van de toiletruimte in m². |
| `toilet[].heated` | Boolean | `true` als de ruimte wordt verwarmd. |
| `toilet[].wall_hung_toilet` | Boolean | `true` als het toilet een wandcloset is. |
| `toilet[].washbasin` | Integer | Aantal wastafels in de toiletruimte (meestal `0` of `1`). |
| `toilet[].shared_addresses` | Integer | Aantal adressen dat de ruimte deelt. `1` voor privé. |
| `build_year` | Integer | Het bouwjaar van de woning (bijv. `2010`). |
| `energy_label` | String | Het energielabel. Moet een van de volgende zijn: `A++++`, `A+++`, `A++`, `A+`, `A`, `B`, `C`, `D`, `E`, `F`, `G`. Kan een lege string `""` zijn indien niet beschikbaar. |
| `energy_index_existence` | Boolean | `true` als er een Energie-Index (EI) waarde beschikbaar is (wordt gebruikt als `energy_label` leeg is). |
| `energy_index` | Float | De numerieke Energie-Index waarde. |
| `energy_performance_compensation` | Boolean | `true` als de woning een energieprestatievergoeding ontvangt. |
| `disability_costs` | Float | Totaal gedocumenteerde kosten voor voorzieningen voor mindervaliden. |
| `disabled_people` | Integer | Aantal mindervalide personen voor wie de voorzieningen zijn bedoeld. |
| `monument` | String | Monumentstatus. Moet een van de volgende zijn: `'national'`, `'municipal'`, `'provincial'`, of een lege string `""`. |
| `doorbell` | Boolean | `true` als de woning een functionerende deurbel heeft. |
| `woz_value` | Float | De officiële WOZ-waarde van de woning in euro's. |
| `woz_valuation_year` | Integer | Het peiljaar van de `woz_value` (bijv. `2023`, `2024`). |
| `corop_area_amsterdam_or_utrecth` | Boolean | `true` alleen als de woning in het COROP-gebied van Amsterdam of Utrecht ligt en aan andere criteria voldoet voor een specifieke WOZ-rekenuitzondering. |
| `care_home` | Boolean | `true` als de woning deel uitmaakt van een geregistreerde zorginstelling, wat een puntenopslag van 35% activeert. |
## Haal wws-punten ophalen voor een woonruimte die een niet-zelfstandige woning vormt, op basis van de regels van versie 01-01-2025
`POST` `https://api.altum.ai/wws/non/01012025`
#### Request Body
| Veld | Type | Toegestane Waarden & Beschrijving |
| -------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rooms`, `kitchen`, `sanitary`, `toilet`, `outdoor`, `parking` | Array van Objects | Deze hebben dezelfde structuur en sub-velden als bij Zelfstandige Woonruimte, met toevoeging van het `shared_spaces` veld. |
| `...[].shared_spaces` | Integer | Aantal onzelfstandige wooneenheden (kamers) dat deze specifieke voorziening deelt. |
| `build_year` | Integer | Het bouwjaar van het pand. |
| `energy_label` | String | Het energielabel van het pand. Moet een van de volgende zijn: `A++++`, `A+++`, `A++`, `A+`, `A`, `B`, `C`, `D`, `E`, `F`, `G`, of `""`. |
| `energy_index_existence` | Boolean | `true` als er een Energie-Index (EI) waarde beschikbaar is. |
| `energy_index` | Float | De numerieke Energie-Index waarde. |
| `disability_costs` | Float | Kosten voor voorzieningen voor mindervaliden. |
| `disabled_people` | Integer | Aantal mindervalide personen voor wie de voorzieningen zijn bedoeld. |
| `monument` | String | Monumentstatus. Moet een van de volgende zijn: `'national'`, `'municipal'`, `'provincial'`, of `""`. |
| `doorbell` | Boolean | `true` als er een deurbel voor de eenheid aanwezig is. |
| `glass_surface_living_room` | Float | Oppervlakte van glas (ramen) in de hoofdleefruimte in m². Gebruikt voor puntenaftrek. |
| `lowest_window_frame_living_room` | Float | Hoogte van het laagste raamkozijn vanaf de vloer in meters. Gebruikt voor puntenaftrek. |
| `accessibility_via_landlord` | Boolean | `true` als toegang tot de eenheid via een door de verhuurder gecontroleerde ruimte gaat. Leidt tot puntenaftrek. |
| `woz_value` | Float | De WOZ-waarde van het **gehele pand** op het adres. |
| `woz_valuation_year` | Integer | Het peiljaar van de `woz_value`. |
| `usable_surface_area` | Float | De totale gebruiksoppervlakte van het **gehele pand** op het adres in m². |
| `corop_region` | String | De COROP-regio waar het pand zich bevindt. Moet een van de volgende zijn (hoofdletterongevoelig): `'east groningen'`, `'delfzijl and surroundings'`, `'other groningen'`, `'north friesland'`, `'southwest friesland'`, `'southeast friesland'`, `'north drenthe'`, `'southeast drenthe'`, `'southwest drenthe'`, `'north overijssel'`, `'southwest overijssel'`, `'twente'`, `'veluwe'`, `'back corner'`, `'arnhem/nijmegen'`, `'southwest gelderland'`, `'utrecht'`, `'head of north holland'`, `'alkmaar and surroundings'`, `'ijmond'`, `'haarlem agglomeration'`, `'zaan region'`, `'greater amsterdam'`, `'the gooi and vecht region'`, `'leiden and bulb region agglomeration'`, `'agglomeration of the hague'`, `'delft westland'`, `'east south holland'`, `'greater rhine estuary'`, `'southeast south holland'`, `'zeelandic flanders'`, `'other zeeland'`, `'west north brabant'`, `'central north brabant'`, `'northeast north brabant'`, `'southeast north brabant'`, `'north limburg'`, `'central limburg'`, `'south limburg'`, `'flevoland'`. |
| `care_home` | Boolean | `true` als het pand een geregistreerde zorginstelling is. |
## Haal wws-punten ophalen voor een woonruimte die een zelfstandige woning vormt, op basis van de regels van versie 01-07-2024
`POST` `https://api.altum.ai/wws/01072024`
#### Request Body
| Block name/General features | Feature | Type | Example |
| ----------------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------- |
| room | type\_of\_room | string, , mogelijke waarden: 'room', 'other' | 'room' |
| | attic\_without\_fixed\_staircase | boolean | true, default = false |
| | surface\_area | float | 12.3, default = 0 |
| | shared\_addresses | integer | 2, default = 1 |
| | heated | boolean | true, default = false |
| | cooled | boolean | true, default = false |
| | | | |
| kitchen | type\_of\_room | string, mogelijke waarden: room', 'other' | 'other' |
| | open\_kitchen | boolean | true |
| | surface\_area | float | 24, default = 0 |
| | countertop\_length | float | 12.5 |
| | shared\_addresses | boolean | 2, default = 1 |
| | heated | boolean | true, default = false |
| | cooled | boolean | true, default = false |
| | **kitchen\_features:** | | |
| | extractor\_system | integer | 1, defaults = 0 |
| | induction\_hob | integer | 3, defaults = 0 |
| | ceramic\_hob | integer | 2, defaults = 0 |
| | gas\_hob | integer | 1, defaults = 0 |
| | refrigerator | integer | 0, defaults = 0 |
| | freezer | integer | 2, defaults = 0 |
| | oven\_electric | integer | 0, default = 0 |
| | oven\_gas | integer | 2, defaults = 0 |
| | microwave | integer | 5, default = 0 |
| | dishwasher | integer | 1, default = 0 |
| | extra\_cupboard\_space\_per\_60cm | integer | 2, defaults = 0 |
| | one\_hand\_mixer\_tap | integer | 3, defaults = 0 |
| | one\_hand\_mixer\_tap\_with\_boiling\_function | integer | 4, defaults = 0 |
| | thermostatic\_mixer\_tap | integer | 1, defaults = 0 |
| | thermostatic\_mixer\_tap\_with\_boiling\_function | integer | 2, defaults = 0 |
| | | | |
| sanitary | type\_of\_room | string, mogelijke waarden: 'room', 'other' | 'other' |
| | surface\_area | float | 25, default = 0 |
| | heated | boolean | true, default = false |
| | cooled | boolean | true, default = false |
| | shower\_facility | string,, mogelijke waarden: \['bath', 'shower/bath', 'shower'] | 'bath' |
| | toilet | integer | 2, default = 0 |
| | wall\_hung\_toilet | integer | 1, default = 0 |
| | shared\_addresses | integer | 3, default = 1 |
| | sanitary\_features: | | |
| | washbasin | integer | 1, default = 0 |
| | multi\_person\_washbasin | integer | 0, default = 0 |
| | cupboard\_space | boolean | true, default = false |
| | power\_outlet | integer | 3, default = 0 |
| | build\_in\_cupboard | integer | 4, default = 0 |
| | complete\_separation\_of\_shower | integer | 1, default = 0 |
| | bath\_with\_bubble\_function | integer | 0, default = 0 |
| | one\_hand\_mixer\_tap | integer | 2, default = 0 |
| | thermostatic\_mixer\_tap | integer | 1, default = 0 |
| | towel\_radiator | integer | 4, default = 0 |
| | | | |
| toilet | type\_of\_room | string, , mogelijke waarden: 'room', 'other' | 'room' |
| | surface\_area | float | 12, default = 0 |
| | heated | boolean | true, default = false |
| | cooled | boolean | true, default = false |
| | wall\_hung\_toilet | boolean | true, default = false |
| | washbasin | integer | 2, default = 0 |
| | shared\_addresses | integer | 2, default = 1 |
| | | | |
| parking | parking\_type | integer, , mogelijke waarden: 1, 2, 3 | 2, default = 0 |
| | surface\_area | float | 12, default = 0 |
| | shared\_addresses | integer | 2, default = 1 |
| | charging\_station | boolean | true, default = false |
| | | | |
| outdoor | surface\_area | float | 32.5, default = 0 |
| | shared\_addresses | integer | 3, default = 1 |
| | | | |
| house\_type | | string, , mogelijke waarden: 'eengezinswoning', 'meergezinswoning', 'duplexwoning' | 'eengezinswoning' |
| build\_year | | integer | |
| energy\_label | | string, , mogelijke waarden:
\['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']
| 'A', default = ' ' |
| energy\_index\_existence | | boolean | true, default = false |
| energy\_index | | float | default |
| energy\_performance\_compensation | | float | 0.5, default = 0 |
| energy\_valuation\_date | | string | '01022022' |
| energy\_label\_type | | string, mogelijke waarden: "NTA 8800", "NEN 7120", "" | "NTA 8800" |
| disability\_costs | | float | 1500.2, default = 0 |
| disabled\_people | | integer | 1, default = 1 |
| monument | | string, mogelijke waarden: 'national', 'municipal', 'provincial', ' ' | 'provincial' , default = ' ' |
| doorbell | | boolean | true, default = false |
| woz\_value | | float | 150000, default = 0 |
| woz\_valuation\_year | | integer, mogelijke waarden: 2022, 2023 | 2022 |
| usable\_surface\_area | | float | 12.5, default = 0 |
| corop\_area\_amsterdam\_or\_utrecth | | boolean | true, default = false |
| care\_home | | boolean | true, default = false |
{% tabs %}
{% tab title="200: OK Successful response" %}
```
{
"total_wws_points": "220",
"points_per_component": {
"inner_surface_area": "85.0",
"heating_cooling": "21.0",
"energy": "11",
"kitchen": "22",
"sanitary": "35.25",
"disabilities": "4.52",
"outdoor": "-5",
"shared_parking": "4.5",
"woz": "40",
"special_provisions": "1.25"
}
}
```
{% endtab %}
{% tab title="400: Bad Request Unsuccessful response" %}
```
{
"We are not able to provide points at the moment."
}
```
{% endtab %}
{% tab title="422: Unprocessable Entity Wrong input format" %}
```
Examples:
{
"detail": "The type_of_room in rooms features should have one of the following values: ['other', 'room']."
}
{
"detail": [
{
"loc": [
"body",
"sanitary",
0,
"shower_facility"
],
"msg": "The shower_facility must be one of ['shower', 'bath', 'shower/bath']",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": " NTA c8800 in not an accepted energy_label_type. Please provide a energy_label_type from the list: ['NTA 8800', 'NEN 7120', '']",
"type": "value_error"
}
]
}
```
{% endtab %}
{% tab title="500: Internal Server Error Service is not available and/or down" %}
```
{
"message": "Internal server error"
}
```
{% endtab %}
{% tab title="403: Forbidden Forbidden" %}
```
{
"message": "Missing Authentication Token"
}
```
{% endtab %}
{% endtabs %}
## Haal wws-punten ophalen voor een woonruimte die een niet-zelfstandige woning vormt, op basis van de regels van versie 01-07-2024
`POST` `https://api.altum.ai/wws/non/01072024`
#### Request Body
| Block name/General features | Feature | Type | Example |
| ----------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------- |
| room | type\_of\_room | string, mogelijke waarden: 'room', 'other' | 'room' |
| | attic\_without\_fixed\_staircase | boolean | true, default = false |
| | surface\_area | float | 12.3, default = 0 |
| | shared\_addresses | integer | 2, default = 1 |
| | shared\_spaces | integer | 2, default = 1 |
| | heated | boolean | true, default = false |
| | cooled | boolean | true, default = false |
| | | | |
| kitchen | type\_of\_room | string, mogelijke waarden: 'room', 'other' | 'other' |
| | open\_kitchen | boolean | true |
| | surface\_area | float | 24, default = 0 |
| | countertop\_length | float | 12.5 |
| | shared\_addresses | integer | 2, default = 1 |
| | shared\_spaces | integer | 2, default = 1 |
| | heated | boolean | true, default = false |
| | cooled | boolean | true, default = false |
| | **kitchen\_features**: | | |
| | extractor\_system | integer | 1, defaults = 0 |
| | induction\_hob | integer | 3, defaults = 0 |
| | ceramic\_hob | integer | 2, defaults = 0 |
| | gas\_hob | integer | 1, defaults = 0 |
| | refrigerator | integer | 0, defaults = 0 |
| | freezer | integer | 2, defaults = 0 |
| | oven\_electric | integer | 0, default = 0 |
| | oven\_gas | integer | 2, defaults = 0 |
| | microwave | integer | 5, default = 0 |
| | dishwasher | integer | 1, default = 0 |
| | extra\_cupboard\_space\_per\_60cm | integer | 2, defaults = 0 |
| | one\_hand\_mixer\_tap | integer | 3, defaults = 0 |
| | one\_hand\_mixer\_tap\_with\_boiling\_function | integer | 4, defaults = 0 |
| | thermostatic\_mixer\_tap | integer | 1, defaults = 0 |
| | thermostatic\_mixer\_tap\_with\_boiling\_function | integer | 2, defaults = 0 |
| | | | |
| sanitary | type\_of\_room | string, mogelijke waarden: 'room', 'other' | 'other' |
| | surface\_area | float | 25, default = 0 |
| | heated | boolean | true, default = false |
| | cooled | boolean | true, default = false |
| | shower\_facility | string, mogelijke waarden: \['bath', 'shower/bath', 'shower'] | 'bath' |
| | toilet | integer | 2, default = 0 |
| | wall\_hung\_toilet | integer | 1, default = 0 |
| | shared\_addresses | integer | 3, default = 1 |
| | shared\_spaces | integer | 2, default = 1 |
| | **sanitary\_features:** | | |
| | washbasin | integer | 1, default = 0 |
| | multi\_person\_washbasin | integer | 0, default = 0 |
| | cupboard\_space | boolean | true, default = false |
| | power\_outlet | integer | 3, default = 0 |
| | build\_in\_cupboard | integer | 4, default = 0 |
| | complete\_separation\_of\_shower | integer | 1, default = 0 |
| | bath\_with\_bubble\_function | integer | 0, default = 0 |
| | one\_hand\_mixer\_tap | integer | 2, default = 0 |
| | thermostatic\_mixer\_tap | integer | 1, default = 0 |
| | towel\_radiator | integer | 4, default = 0 |
| | | | |
| toilet | type\_of\_room | string, mogelijke waarden: 'room', 'other' | 'room' |
| | surface\_area | float | 12, default = 0 |
| | heated | boolean | true, default = false |
| | cooled | boolean | true, default = false |
| | wall\_hung\_toilet | boolean | true, default = false |
| | washbasin | integer | 2, default = 0 |
| | shared\_addresses | integer | 2, default = 1 |
| | shared\_spaces | integer | 3, default = 1 |
| | | | |
| parking | parking\_type | integer, mogelijke waarden: 1, 2, 3 | 2, default = 0 |
| | surface\_area | float | 12, default = 0 |
| | shared\_addresses | integer | 2, default = 1 |
| | shared\_spaces | integer | 2, default = 1 |
| | charging\_station | boolean | true, default = false |
| | | | |
| outdoor | surface\_area | float | 32.5, default = 0 |
| | shared\_addresses | integer | 3, default = 1 |
| | shared\_spaces | integer | 2, default = 1 |
| | | | |
| build\_year | | integer | |
| energy\_label | | string, mogelijke waarden:
\['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']
| 'A', default = ' ' |
| energy\_index\_existence | | boolean | true, default = false |
| energy\_index | | float | default |
| disability\_costs | | float | 1500.2, default = 0 |
| disabled\_people | | integer | 1, default = 1 |
| monument | | string, mogelijke waarden: 'national', 'municipal', 'provincial', ' ' | 'provincial' , default = ' ' |
| doorbell | | boolean | true, default = false |
| woz\_value | | float | 150000, default = 0 |
| woz\_valuation\_year | | integer, mogelijke waarden: 2021, 2022, 2023 | 2022 |
| usable\_surface\_area | | float | 12.5, default = 0 |
| corop\_region | | boolean | true, default = false |
| care\_home | | boolean | true, default = false |
| glass\_surface\_living\_room | | float | 1.8, default = 0.75 |
| lowest\_window\_frame\_living\_room | | float | 2.4, default = 1.6 |
| accessibility\_via\_landlord | | boolean | true, default = false |
{% tabs %}
{% tab title="200: OK Successful response" %}
```
{
"total_wws_points": "390",
"points_per_component": {
"inner_surface_area": "117.5",
"heating_cooling": "9.0",
"energy": "79.62",
"kitchen": "14",
"sanitary": "28.25",
"disabilities": "4.52",
"outdoor": "15",
"shared_parking": "2.0",
"woz": "14",
"special_provisions": "110.28",
"deductions": "-4"
}
}
```
{% endtab %}
{% tab title="400: Bad Request Unsuccessful response" %}
```
{
"We are not able to provide points at the moment."
}
```
{% endtab %}
{% tab title="422: Unprocessable Entity Wrong input format" %}
```
{
"detail": [
{
"loc": [
"body",
"outdoor",
0,
"shared_addresses"
],
"msg": "ensure this value is greater than 0",
"type": "value_error.number.not_gt",
"ctx": {
"limit_value": 0
}
},
{
"loc": [
"body",
"energy_label"
],
"msg": "The energy_label must be one of ['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']",
"type": "value_error"
},
{
"loc": [
"body",
"disabled_people"
],
"msg": "ensure this value is greater than 0",
"type": "value_error.number.not_gt",
"ctx": {
"limit_value": 0
}
},
{
"loc": [
"body",
"woz_valuation_year"
],
"msg": "woz_valuation_year must be 2021, 2022, or 2023",
"type": "value_error"
}
]
}
```
{% endtab %}
{% tab title="500: Internal Server Error Service is not available and/or down" %}
```
{
"message": "Internal server error"
}
```
{% endtab %}
{% tab title="403: Forbidden Forbidden" %}
```
{
"message": "Missing Authentication Token"
}
```
{% endtab %}
{% endtabs %}
## Haal wws-punten ophalen voor een woonruimte die een zelfstandige woning vormt, op basis van de regels van versie 01-01-2024
`POST` `https://api.altum.ai/wws/01012024`
#### Request Body
| Name | Type | Example |
| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| living\_area\_m2 | float | 125.0, default = 0 |
| toilet\_installed\_in\_bathroom\_or\_shower | boolean | true, default = False |
| surface\_area\_other\_spaces | float | 128.0, default = 0 |
| attic\_space\_area | float | 12.3, default = 0 |
| fixed\_staircase | boolean | false, default = False |
| no\_of\_heated\_rooms | integer | 2, default = 0 |
| no\_of\_other\_rooms | integer | 3, default = 0 |
| no\_of\_rooms\_heat\_as\_service\_cost | integer | 0, default = 0 |
| house\_type | string, mogelijke waarden: \['Eengezinswoning', 'Meergezinswoning', 'Duplexwoning'] | 'Eengezinswoning' |
| building\_year | integer | 2015 |
| energy\_label\_available | boolean | true, default = False |
| energy\_label | string, mogelijke waarden: \['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G'] | 'A++', default = '' lege tekenreeks |
| energy\_performance\_payment | boolean | false, default = False |
| inner\_surface\_area | float | 78.5, default = 0 |
| validity | string, mogelijke waarden: \['definitive', ‘expired’, ‘estimated’] | 'estimated', default = '' lege tekenreeks |
| countertop\_with\_base\_cabinets | boolean | true, default = False |
| countertop\_lenght | float | 2, defaults = 0 |
| investment\_for\_kitchen\_extra\_quality | float | 15000, defaul = 0 |
| sanitary\_facilities | boolean | |
| list\_sanitary\_facilities | lijst met sanitaire voorzieningen, mogelijke waarden: \["toilet", "sink", "bath", “bath shower”, “shower”] | \['toilet', 'shower'], default = \[] lege lijst |
| investment\_for\_bath\_extra\_quality | float | 0, defaults = 0 |
| investment\_for\_shower\_extra\_quality | float | 6000, default = 0 |
| investment\_for\_bath\_shower\_extra\_quality | float | 0, default = 0 |
| facilities\_for\_disabled | boolean | true, default = False |
| costs\_spent\_for\_facilities\_for\_disabled | float | 15000, default = 0 |
| private\_outdoor\_space\_m2 | float | 15, default = 0 |
| carport | boolean | false, default = False |
| extra\_quality\_above\_100m2 | boolean | false, default = False |
| renovation\_expenses | float | 15000, default = 0 |
| renovation\_year | integer | 2015, default = 0 |
| monument | boolean | true, default = False |
{% tabs %}
{% tab title="200: OK Succesvolle reactie" %}
```
{
"total_wws_points": "537.3",
"points_per_component": {
"1_area_of_rooms": "125",
"2_surface_area_other_spaces": "48.8",
"3_heating": "4",
"4_energy_label": "68",
"5_kitchen": "14",
"6_sanitary_facilities": "16",
"7_facilities_for_disables": "66.1",
"8_private_outdoor_spaces": "14",
"9_woz_value": "6.8",
"10_renovation": "0",
"11_special_facilities": "124.6",
"12_monument": "50"
}
}
```
{% endtab %}
{% tab title="400: Bad Request Mislukte reactie" %}
```
{
"We are not able to provide points at the moment."
}
```
{% endtab %}
{% tab title="422: Unprocessable Entity Verkeerd invoerformaat" %}
```
Examples:
{
"detail": [
{
"loc": [
"body",
"source"
],
"msg": "unexpected value; permitted: 0, 1",
"type": "value_error.const",
"ctx": {
"given": 2,
"permitted": [
0,
1
]
}
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "The energy_label must be one of ['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "If sanitary_facilities is True, list_sanitary_facilities cannot be an empty list. Please provide a list with the sanitary facilities",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"list_sanitary_facilities",
0
],
"msg": "The word 'TOILfET' is not spelled correctly, or it is not in the acceptable sanitary facilities. Choose between ['toilet', 'sink', 'bath', 'shower', 'bath shower']",
"type": "value_error"
},
{
"loc": [
"body",
"__root__"
],
"msg": "If sanitary_facilities is True, list_sanitary_facilities cannot be an empty list. Please provide a list with the sanitary facilities",
"type": "value_error"
}
]
}
```
{% endtab %}
{% tab title="500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar" %}
```
{
"message": "Internal server error"
}
```
{% endtab %}
{% tab title="403: Forbidden Verboden" %}
```
{
"message": "Missing Authentication Token"
}
```
{% endtab %}
{% endtabs %}
## Haal wws-punten ophalen voor een woonruimte die een niet-zelfstandige woning vormt, op basis van de regels van versie 01-01-2024
`POST` `https://api.altum.ai/wws/non/01012024`
| Name | Type | Example |
| ----------------------------------- | ----------------------------------------------------- | --------------------------------------- |
| area\_of\_rooms\_m2 | float | 128, default = 0 |
| other\_surface\_area\_m2 | float | 126, default = 0 |
| number\_of\_living\_spaces | integer | 2, default = 0 |
| central\_heating | boolean | false, default = False |
| heated\_rooms\_m2 | float | 12, default = 0 |
| gas\_connection | boolean | true, default = False |
| flue\_gas\_discharge\_duct | boolean | false, default = False |
| chimney | boolean | true, default = False |
| kitchen | integer, mogelijke waarden: \[0, 1, 2, 3, 4, 5, 6, 7] | 3, default = 0 |
| toilet | integer, mogelijke waarden: \[0, 1, 2, 3, 4] | 1, default = 0 |
| shower\_bath | integer, mogelijke waarden: \[0, 1, 2, 3] | 2, default = 0 |
| sink | integer, mogelijke waarden: \[0, 1, 2, 3] | 3, default = 0 |
| thermostatic\_control\_knobs | boolean | true, default = False |
| outdoor\_space\_m2 | float | 32, default = 0 |
| outdoor\_area\_for\_shared\_use\_m2 | float | 12, default = 0 |
| bicycle\_shed | string, mogelijke waarden: \['private', 'shared'] | 'private', default = '' lege tekenreeks |
| living\_sleeping\_area\_m2 | float | 12, default = 0 |
| through\_others\_room | boolean | true, default = False |
| window\_area\_main\_living\_room | float | 10, default = 0 |
| lowest\_window\_frame\_height\_m | float | 2, default = 0 |
| facade\_wall | boolean | true, default = False |
| severe\_nuisance | boolean | false, default = False |
| living\_room\_floor\_number | integer | 6, default = 0 |
| elevator\_existence | boolean | true, default = False |
| hot\_meal\_preparation\_allowed | boolean | true, default = False |
| monument | boolean | false, default = False |
{% tabs %}
{% tab title="200: OK Succesvolle reactie" %}
```
{
"total_wws_points": "790.7",
"points_per_component": {
"1_area_of_rooms": "694.2",
"2_heating_options": "3",
"3_cooking_facilities": "20",
"4_toilet": "0",
"5_washing_facilities": "13",
"6_quality_factors": "10.5",
"7_monument": "50"
}
}
```
{% endtab %}
{% tab title="400: Bad Request Mislukte reactie" %}
```
{
"We are not able to provide points at the moment."
}
```
{% endtab %}
{% tab title="422: Unprocessable Entity Verkeerd invoerformaat" %}
```
Examples:
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "The sink must be one of ['private', 'shared']",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "The toilet must be one of [0, 1, 2, 3, 4]",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "The shower_bath must be one of [0, 1, 2, 3]",
"type": "value_error"
}
]
}
```
{% endtab %}
{% tab title="500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar" %}
```
{
"message": "Internal server error"
}
```
{% endtab %}
{% tab title="403: Forbidden Verboden" %}
```
{
"message": "Missing Authentication Token"
}
```
{% endtab %}
{% endtabs %}