- Created by Thomas De Langhe, last modified on 18 Jan, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4 Next »
Situering
Deze dienst laat toe om de conditiescore op te halen voor een woning op basis van het VmswWoningId
Vraag
Parameters
Naam | Type | Verplicht | Omschrijving |
|---|---|---|---|
x-correlation-id | Header | Ja | Referte (uuid) om de actie uniek te identificeren |
vmswWoningId | Path | Ja | Identificatie van de woning. |
Validaties
Er zijn geen validaties in deze methode
Inhoud
De vraag bevat geen payload
Antwoord
Inhoud
Element | Omschrijving | ||||
|---|---|---|---|---|---|
@context | De URL van de context die bij dit schema hoort. | ||||
@id | Het pad naar de details van deze woning op het VMSW platform | ||||
@magdaId | Het pad naar de details van deze woning op het MAGDA platform | ||||
@type | Aanduiding van het type object, default : ConditiescoreVoorWoningResource | ||||
value | |||||
voorWoning | Het volledige pad waarmee de woninggegevens kunnen opgevraagd worden op het VMSW platform | ||||
magdaVoorWoning | Het volledige pad waarmee de woninggegevens kunnen opgevraagd worden op het MAGDA platform. Indien het voorWoning element geen correcte data bevat zal dit element weggelaten worden | ||||
gebouwstaat | |||||
naam | |||||
groepen | |||||
naam | |||||
scores | |||||
@type | |||||
woningKenmerk | |||||
woningKenmerk - @id | relatief pad van de woningkenmerk resource op het VMSW platform | ||||
woningKenmerk - @magdaId | Absoluut pad van de woningkenmerk resource op het MAGDA platform | ||||
woningKenmerk - @type | Aanduiding van het type object, default : WoningKenmerkDefinitieResource | ||||
woningKenmerk - label | Naam van de woningkenmerk score | ||||
woningKenmerk - code | Code van het woningkenmerk | ||||
score | |||||
scoreLabel | |||||
wegingsfactorProcent | |||||
totaalProcent | |||||
veiligheidEnGezondheid | |||||
naam | |||||
groepen | array | ||||
naam | |||||
scores | array | ||||
@type | |||||
woningKenmerk | |||||
woningKenmerk - @id | relatief pad van de woningkenmerk resource op het VMSW platform | ||||
woningKenmerk - @magdaId | Absoluut pad van de woningkenmerk resource op het MAGDA platform | ||||
woningKenmerk - @type | Aanduiding van het type object, default : WoningKenmerkDefinitieResource | ||||
woningKenmerk - label | Naam van de woningkenmerk score | ||||
woningKenmerk - code | Code van het woningkenmerk | ||||
score | |||||
scoreLabel | |||||
wegingsfactorProcent | |||||
totaalProcent | |||||
gebouwstaatScoreProcent | |||||
gebouwstaatWegingsfactorProcent | |||||
veiligheidEnGezondheidScoreProcent | |||||
veiligheidEnGezondheidWegingsfactorProcent | |||||
totaalScoreProcent | |||||
Response codes <> 20X
MAGDA streeft ernaar om de berichtgeving bij een “unhappy flow” zoveel mogelijk te standaardiseren. De standaard response codes en de inhoud van de bijhorende errormessage is terug te vinden op Werking en overzicht uitzonderingen MAGDA RESTful services
Afwijkingen ten opzichte van deze standaard, specifiek voor deze operatie zijn hieronder te vinden. Deze afwijkingen zijn over het algemeen noodzakelijk doordat de bron het niet mogelijk maakt om de standaard te volgen of omdat de bron extra data doorgeeft.
Response code 400
Bij validatie fouten zal VMSW de errormessage uitbreiden met de verschillende validaties die falen door een validationErrors element toe te voegen. MAGDA neemt deze informatie over.
{
"validationErrors": [
{
"name": "string",
"reason": "string"
}
],
"title": "string",
"status": 0,
"detail": "string"
}
Response code 404
Indien VMSW een 404 terug geeft is geen woning gevonden voor de opgegeven path parameters. MAGDA neemt deze foutmelding over met de toevoeging van “Source: “ in het detail element.
{
"title": "Not found",
"status": 404,
"detail": "Source: Geen woning gevonden",
"instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
}
Response code 500 van VMSW
Indien VMSW een 500 terug geeft zal MAGDA een 502 terug geven aan de afnemer. In de payload van VMSW zit enkel een message welke wordt overgenomen in het detail element, voorafgegaan door “Source: “.
{
"title": "Bad Gateway",
"status": 502,
"detail": "Unexpected error from the source"
}
Voorbeelden
Vraag
GET socZek/socialeHuisvesting/woningen/987654/conditiescore
Waarom is magdaId en magdaVoorWoning afwezig in het voorbeeld van markthuurwaarden?
Antwoord
{
"@context": "string",
"@id": "https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}/conditiescore",
"@magdaId": "string",
"@type": "ConditiescoreVoorWoningResource",
"value": {
"voorWoning": "https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}",
"magdaVoorWoning": "string",
"gebouwstaat": {
"naam": "string",
"groepen": [
{
"naam": "string",
"scores": [
{
"@type": "ConditiescoreWoningKenmerkScoreResource",
"woningKenmerk": {
"@id": "/v1/woningkenmerken/{code}",
"@magdaId": "string",
"@type": "WoningKenmerkDefinitieResource",
"label": "string",
"code": "string"
},
"score": "string",
"scoreLabel": "string",
"wegingsfactorProcent": 0,
"totaalProcent": 0
}
],
"wegingsfactorProcent": 0,
"totaalProcent": 0
}
]
},
"veiligheidEnGezondheid": {
"naam": "string",
"groepen": [
{
"naam": "string",
"scores": [
{
"@type": "ConditiescoreWoningKenmerkScoreResource",
"woningKenmerk": {
"@id": "/v1/woningkenmerken/{code}",
"@magdaId": "string",
"@type": "WoningKenmerkDefinitieResource",
"label": "string",
"code": "string"
},
"score": "string",
"scoreLabel": "string",
"wegingsfactorProcent": 0,
"totaalProcent": 0
}
],
"wegingsfactorProcent": 0,
"totaalProcent": 0
}
]
},
"gebouwstaatScoreProcent": 0,
"gebouwstaatWegingsfactorProcent": 0,
"veiligheidEnGezondheidScoreProcent": 0,
"veiligheidEnGezondheidWegingsfactorProcent": 0,
"totaalScoreProcent": 0
}
}
Op deze pagina
- No labels
