Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Situering
Deze methode maakt het mogelijk om de gegevens van een bestaande woning te wijzigen
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
Element
Omschrijving
status
Mogewijke waarden:
In beheer
Uit beheer
eigenaarOrganisatieId
KBO nummer van de organisatie die eigenaar is van de woning
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
Formaat : jjjj
bebouwingsType
Mogelijke waarden:
Gesloten bebouwing
Halfopen bebouwing
Open bebouwing
Appartement vloer
Appartement hoek vloer
Appartement midden
Appartement zij
Appartement dak
Appartement hoek dak
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
@type
Aanduiding van het type object, default : WivWoningResource
value
eigenaar
@type
Aanduiding van het type object, default : OrganisatieResource
organisatieType
Type organisatie
Mogelijke waarden:
Woonmaatschappij
OCMW
Gemeente
Private initiatiefnemer
organisatieId
KBO nummer van de organistatie
beheerder
@type
Aanduiding van het type object, default : OrganisatieResource
organisatieType
Type organisatie
Mogelijke waarden:
Woonmaatschappij
OCMW
Gemeente
Private initiatiefnemer
organisatieId
KBO nummer van de organistatie
verhuringsStelsel
Type verhuringsstelsel
Mogelijke waarden:
Sociale verhuur gesubsidieerd
Geconventioneerde verhuur
Sociale verhuur
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
vmswWoningId
ID van de woning binnen VMSW
gebouweenheidIds
Array van gebouweenheidsIds
string
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 van de wijk
woningType
Mogelijke waarden:
Woning
Appartement
woningStatus
Mogelijke waarden:
In beheer
Uit beheer
bebouwingsType
Mogelijke waarden:
Gesloten bebouwing
Halfopen bebouwing
Open bebouwing
Appartement vloer
Appartement hoek vloer
Appartement midden
Appartement zij
Appartement dak
Appartement hoek dak
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.
| Code Block |
|---|
{
"validationErrors": [
{
"name": "string",
"reason": "string"
}
],
"type" : ""https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
"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.
| Code Block |
|---|
{
"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: “.
| Code Block |
|---|
{
"title": "Bad Gateway",
"status": 502,
"detail": "Source: Internal server error",
"instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
} |
Voorbeelden
Vraag
| Expand | ||
|---|---|---|
|
Antwoord
| Expand | ||
|---|---|---|
|
voor een specifieke VmswWoningId
Vraag
In de vraag wordt een specifieke VmswWoningId meegegeven met daarbij de eigenschappen die moeten wijzigen.
Antwoord
Het antwoord bevat de gegevens van de woning voor die VmswWoningId.
Op deze pagina
| Table of Contents | ||
|---|---|---|
|
Binnen deze handleiding
| Child pages (Children Display) |
|---|