- Created by Bert Van Kets, last modified on 27 Apr, 2023
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Next »
Situering
Deze methode maakt het mogelijk om een woning aan te maken bji VMSW
Vraag
Parameters
Naam | Type | Verplicht | Omschrijving |
|---|---|---|---|
x-correlation-id | Header | Ja | Referte (uuid) om de actie uniek te identificeren |
Validaties
Er zijn geen validaties in deze methode
Inhoud
Element | Omschrijving | |
|---|---|---|
typeEigendom | Mogelijke waarden:
| |
gebouweenheidId | Gebouweenheids ID vanuit het Vlaams GebouwenRegister | |
woonmaatschappijWoningId | Het Id van de woning in de applicatie van de woonmaatschappij | |
woonmaatschappijWoningCode | De code voor de woning in de applicatie van de woonmaatschappij | |
woonmaatschappijWoningGroepCode | De code van de groep waartoe de woning behoort | |
adres | ||
straatnaam | Naam van de straat | |
huisnummer | Huisnummer | |
busnummer | Busnummer | |
postcode | Postcode van de gemeente | |
gemeenteNISCode | NISCode van de gemeente | |
bouwjaar | Jaar waarin het gebouw gebouwd wazs | |
bebouwingsType | Mogelijke waarden:
| |
eigendom | Mogelijke waarden:
| |
Antwoord
Inhoud
Element | Omschrijving | ||
|---|---|---|---|
@context | |||
@id | |||
@type | |||
vmswWoningId | ID van de woning binnen VMSW | ||
gebouweenheidId | GebouweenheidsID zoals genoteerd in het Vlaams GebouwenRegister | ||
adres | |||
straatnaam | |||
@type | Vaste waarde “http://www.w3.org/1999/02/22-rdf-syntax-ns#langString“ | ||
spelling | Naam van de straat | ||
taal | Taalcode van de staatnaam. Meestal “nl-BE” | ||
huisnummer | Huisnummer van het adres | ||
busnummer | Busnummer van het adres | ||
postcode | Postcode van de gemeente | ||
gemeentenaam | |||
@type | Vaste waarde “http://www.w3.org/1999/02/22-rdf-syntax-ns#langString“ | ||
spelling | Naam van de gemeente | ||
taal | Taalcode van de staatnaam. Meestal “nl-BE” | ||
gemeentenNISCode | NISCode van de gemeente | ||
statistischeSector | |||
wijk | Naam va de wijk | ||
woningType | Mogelijke waarden:
| ||
woonmaatschappijWoningId | Het Id van de woning in de applicatie van de woonmaatschappij | ||
woonmaatschappijWoningCode | De code voor de woning in de applicatie van de woonmaatschappij | ||
woonmaatschappijWoningGroepCode | De code van de groep waartoe de woning behoort | ||
bouwjaar | Jaar waarin het gebouw gebouwd is Formaat: jjjj | ||
bebouwingsType | Mogelijke waarden:
| ||
eigendom | Mogelijke waarden:
| ||
typeEigendom | Mogelijke waarden:
| ||
woningStatus | Mogelijke waarden:
| ||
Response codes <> 20X
MAGDA streeft ernaar om de berichgeving 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": "Source: Internal server error",
"instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
}
Voorbeelden
Vraag
POST socialeHuisvesting/woningen
x-correlation-id : "1748bced-864b-4121-bc9c-f416405c263b"
{
"typeEigendom": "Privaat",
"gebouweenheidId": "16480205",
"woonmaatschappijWoningId": "O02034#22",
"woonmaatschappijWoningCode": "29 06 00 00 00 27",
"woonmaatschappijWoningGroepCode": "ZJV-JVB-V",
"adres": {
"straatnaam": "string",
"huisnummer": "string",
"busnummer": "string",
"postcode": "string",
"gemeenteNISCode": "string"
},
"bouwjaar": 0,
"bebouwingsType": "Gesloten bebouwing",
"eigendom": "Eigen"
}
Antwoord
{
"@context": "string",
"@id": "https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}",
"@type": "VmswWoningResource",
"value": {
"organisatieId": "0403795657",
"vmswWoningId": "string",
"gebouweenheidIds": [
"string"
],
"adres": {
"straatnaam": {
"@type": "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString",
"spelling": "string",
"taal": "nl-BE"
},
"huisnummer": "string",
"busnummer": "string",
"postcode": "string",
"gemeentenaam": {
"@type": "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString",
"spelling": "string",
"taal": "nl-BE"
},
"gemeenteNISCode": "string"
},
"statistischeSector": "string",
"wijk": "string",
"woningType": "Woning",
"woonmaatschappijWoningId": "O02034#22",
"woonmaatschappijWoningCode": "29 06 00 00 00 27",
"woonmaatschappijWoningGroepCode": "ZJV-JVB-V",
"bouwjaar": 0,
"bebouwingsType": "Gesloten bebouwing",
"eigendom": "Eigen",
"typeEigendom": "Privaat",
"woningStatus": "In beheer"
}
}
Op deze pagina
- No labels
