Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Situering
Deze methode maakt het mogelijk om een bestaande woning te zoeken op basis van query parameters
Vraag
Parameters
Naam | Type | Verplicht | Omschrijving |
|---|---|---|---|
x-correlation-id | Header | Ja | Referte (uuid) om de actie uniek te identificeren |
organisatieId | Path | Ja | Identificatie, KBO nummer, van de woonmaatschappij. |
woonmaatschappijWoningId | query | Neen | Het Id van de woning in de applicatie van de woonmaatschappij |
woonmaatschppijWoningCode | query | Neen | De code voor de woning in de applicatie van de woonmaatschappij |
gebouweenheidId | query | Neen | GebouweenheidsID zoals genoteerd in het Vlaams GebouwenRegister |
straatnaam | query | Neen | Naam van de straat |
huisnummer | query | Neen | Huisnummer |
busnummer | query | Neen | Busnummer |
postcode | query | Neen | Postcode van de gemeente |
gemeenteNISCode | query | Neen | GemeenteNISCode |
Validaties
MAGDA doet geen expliciete validatie op de request
Inhoud
De vraag bevat geen payload
Antwoord
Inhoud
Het antwoord bevat slechts 1 gebouw.
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.
| Code Block |
|---|
{
"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.
| 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
| Code Block |
|---|
GET socZek/socialeHuisvesting/woningen |
Antwoord
| Expand | ||
|---|---|---|
|
Op deze pagina
| Table of Contents | ||
|---|---|---|
|