openapi: 3.0.3
info:
title: VMSW Woningen
description: 'This RESTful API is designed to query current data registered at VMSW. Release date October, 2023.'
contact:
name: "Magda helpdesk"
email: helpdesk.magda@vlaanderen.be
license:
name: socialeHuisvestingAPI
url: 'https://overheid.vlaanderen.be/magda'
version: '0.4'
servers:
- url: /api/v1/socZek
paths:
'/socialeHuisvesting/dossiers/zoeken':
post:
tags:
- CIR - Dossiers
operationId: CIRApi_dossiersZoeken
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: Dossier zoek criteria
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstZoekCriteria'
example: {"dossierType":null,"dossierStatus":"REG","dossierNummer":null,"postCode":"3500","aanvragerRijksregisternummer":"65052643390","creatieDatumVanaf":"2023-07-31T00:00:00+00:00","creatieDatumTot":null,"updateDatumVanaf":null,"updateDatumTot":null,"ontvangstDatumVanaf":null,"ontvangstDatumTot":null,"nietGesynchroniseerd":null,"partijCode":null}
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstZoekResultaten'
204:
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstZoekResultaten'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/dossier/{dossierNummer}':
get:
tags:
- CIR - Dossiers
operationId: CIRApi_dossier
parameters:
- name: dossierNummer
in: path
description: Nummer van het gevraagde dossier
required: true
schema:
type: string
nullable: true
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstDossier'
204:
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstDossier'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
put:
tags:
- CIR - Dossiers
operationId: CIRApi_dossierUpdate
parameters:
- name: dossierNummer
in: path
description: Nummer van het gevraagde dossier
required: true
schema:
type: string
nullable: true
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: bijgerkte dossier informatie
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstDossierWijziging'
responses:
200:
description: Success
content:
application/json:
schema:
type: integer
format: int64
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/dossierMetBijlages/{dossierNummer}':
get:
tags:
- CIR - Dossiers
operationId: CIRApi_dossierMetBijlagen
summary: Geeft de detail informatie van een welbepaald dossier terug, inclusief de inhoud van de bijlages
description: "Het CIR centraliseert alle dossiers\r\n<br />Deze methode maakt het mogelijk om alle informatie over een bepaalhet dossier op te halen"
parameters:
- name: dossierNummer
in: path
description: Nummer van het gevraagde dossier
required: true
schema:
type: string
nullable: true
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstDossier'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/bevestigDossierVerwerking':
post:
tags:
- CIR - Dossiers
operationId: CIRApi_BevestigDossierVerwerking
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: Dossier bevestiging
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstDossierVersieBevestiging'
responses:
200:
description: OK
content:
application/json:
schema:
type: boolean
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/wijzigDossierRangschikkingen':
post:
tags:
- CIR - Dossiers
operationId: CIRApi_WijzigDossierRangschikkingen
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: Dossier Ranglijsten
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstDossierRanglijstWijzigingen'
responses:
200:
description: OK
content:
application/json:
schema:
type: integer
format: int64
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/zwarteLijstMeldingen':
post:
tags:
- CIR - Dossiers
operationId: CIRApi_ZwartelijstMeldingen
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: Zwarte Lijst Melding
content:
application/json:
schema:
$ref: '#/components/schemas/ZwarteLijstMeldingen'
responses:
200:
description: OK
content:
application/json:
schema:
type: boolean
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/bijlage':
post:
tags:
- CIR - Dossiers
operationId: CIRApi_bijlage
summary: >-
Haalt een specifiek bestand op van een dossier aan de hand van het dossiernummer en bijlage identificatie.
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstBijlageCriteria'
responses:
200:
description: Success
content:
application/octet-stream:
schema:
type: string
format: binary
nullable: true
204:
description: No Content
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/partijInformatieWijzigingen':
post:
tags:
- CIR - Dossiers
operationId: CIRApi_PartijInformatieWijziging
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: Partij Informatie
content:
application/json:
schema:
$ref: '#/components/schemas/PartijInformatieWijzigingen'
responses:
200:
description: OK
content:
application/json:
schema:
type: boolean
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/zwarteLijstMeldingVoor':
post:
tags:
- CIR - Dossiers
operationId: CIRApi_zwarteLijstMelding
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetZwarteLijstMeldingVerzoek'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetZwarteLijstMelding'
204:
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/GetZwarteLijstMelding'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/dossiers/verwerkDossierActie':
post:
tags:
- CIR - Dossiers
operationId: CIRApi_VerwerkDossier
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: Zwarte Lijst Melding
content:
application/json:
schema:
$ref: '#/components/schemas/DossierDienstDossierActie'
responses:
200:
description: OK
content:
application/json:
schema:
type: boolean
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/gemeentes':
get:
tags:
- CIR - Gemeentes
operationId: CIRApi_Gemeentes
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GemeenteDienstZoekResultaats'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/gemeentes/wijkenVoorGemeente/{gemeenteNisCode}':
get:
tags:
- CIR - Gemeentes
operationId: CIRApi_Wijken
parameters:
- name: gemeenteNisCode
in: path
description: Stad of gemeente code (NIS)
required: true
schema:
type: string
nullable: true
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GemeenteDienstWijken'
204:
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/GemeenteDienstWijken'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
put:
tags:
- CIR - Gemeentes
operationId: CIRApi_GemeenteBijwerken
parameters:
- name: gemeenteNisCode
in: path
description: NIS Code van de hoofdgemeente
required: true
schema:
type: string
nullable: true
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: Zwarte Lijst Melding
content:
application/json:
schema:
$ref: '#/components/schemas/GemeenteDienstWijken'
responses:
200:
description: OK
content:
application/json:
schema:
type: boolean
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningen/{vmswWoningId}':
get:
tags:
- CWR-Woningen
description: Woninggegevens ophalen op basis van het VmswWoningId
operationId: GET_Woning
parameters:
- name: vmswWoningId
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WoningV2Response'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
patch:
tags:
- CWR-Woningen
description: Gegevens van een bestaande woning wijzigen.
operationId: PATCH_WoningDetailsWijzigen
parameters:
- name: vmswWoningId
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/V2WoningWijzigen'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WoningV2Response'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningen':
get:
tags:
- CWR-Woningen
description: Bestaande woning zoeken.
operationId: GET_Woningen
parameters:
- name: woonmaatschappijWoningId
in: query
schema:
type: string
- name: woonmaatschappijWoningCode
in: query
schema:
type: string
- name: gebouweenheidId
in: query
schema:
type: string
- name: straatnaam
in: query
schema:
type: string
- name: huisnummer
in: query
schema:
type: string
- name: busnummer
in: query
schema:
type: string
- name: postcode
in: query
schema:
type: string
- name: gemeenteNISCode
in: query
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/WoningV2Response'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
post:
tags:
- CWR-Woningen
description: Woning aanmaken bij VMSW.
operationId: POST_Woning
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2WoningToevoegen'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WoningV2Response'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningen/{vmswWoningId}/woningkenmerkscores':
get:
tags:
- CWR-Woningkenmerken
description: Woningkenmerkscores ophalen voor een woning op basis van het VmswWoningId.
operationId: GET_Woningkenmerkscores
parameters:
- name: vmswWoningId
in: path
required: true
schema:
type: string
- name: woningKenmerkCategorie
in: query
schema:
$ref: '#/components/schemas/WoningKenmerkCategorie'
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/WoningKenmerkScoresResponse'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
patch:
tags:
- CWR-Woningkenmerken
description: WoningkenmerkScores updaten voor kenmerken van een specifiek woning.
operationId: PATCH_Woningkenmerkscores
parameters:
- name: vmswWoningId
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WoningKenmerkScoreWijzigen'
responses:
200:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/WoningKenmerkScoresResponse'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningbezettingen':
post:
tags:
- CWR-Woningen
summary: Nieuwe bezetting
operationId: nieuwe-woningbezetting
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WoningBezetting'
responses:
201:
$ref: '#/components/responses/Response'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningbezettingen/{woning-bezetting-id}':
patch:
summary: Update bezetting
tags:
- CWR-Woningen
operationId: update-woning-bezetting
parameters:
- name: woning-bezetting-id
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WoningBezetting'
responses:
200:
description: OK
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
delete:
summary: Verwijder bezetting
description: 'Woonmaatschappij verwijdert informatie over bestaande bezetting in CWR, bijvoorbeeld indien iets foutief doorgestuurd werd'
operationId: delete-woning-bezetting
tags:
- CWR-Woningen
parameters:
- name: woning-bezetting-id
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
204:
description: No Content
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
get:
operationId: get-woning-bezetting
parameters:
- name: woning-bezetting-id
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
tags:
- CWR-Woningen
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/notificaties/{registerId}/messages/head':
post:
tags:
- Notificaties
summary: Lees en vergrendel bericht
description: >-
Het bericht dat gelezen wordt, wordt gelocked en moet nadien opnieuw
worden vrijgegeven via een PUT call.
operationId: POST_Messages
parameters:
- name: registerId
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
201:
description: Message successfully retrieved and locked.
headers:
Content-Type:
required: true
schema:
type: string
description: Media-type of the resource
default: application/atom+xml;type=entry;charset=utf-8
BrokerProperties:
description: >-
JSON-encoded representation for the unit of communication
between Service Bus clients. More info on:
https://learn.microsoft.com/en-us/rest/api/servicebus/message-headers-and-properties
required: true
schema:
type: object
example:
CorrelationId: 44d276e3-81a6-410c-a1ba-06573f254851
LockToken: 73f378c2-2c64-403b-91df-a711cc56cbb0
MessageId: random string
content:
application/json:
schema:
$ref: '#/components/schemas/AsynchroonBerichtResponse'
204:
description: No messages available within the specified timeout period.
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
delete:
tags:
- Notificaties
summary: Lees en verwijder bericht
operationId: LeesEnVerwijderBericht
parameters:
- name: registerId
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: OK
headers:
Content-Type:
required: true
schema:
type: string
description: Media-type of the resource
default: application/atom+xml;type=entry;charset=utf-8
BrokerProperties:
description: >-
JSON-encoded representation for the unit of communication
between Service Bus clients. More info on:
https://learn.microsoft.com/en-us/rest/api/servicebus/message-headers-and-properties
required: true
schema:
type: object
example:
CorrelationId: 44d276e3-81a6-410c-a1ba-06573f254851
LockToken: 73f378c2-2c64-403b-91df-a711cc56cbb0
MessageId: random string
content:
application/json:
schema:
$ref: '#/components/schemas/AsynchroonBerichtResponse'
204:
description: No messages available within the specified timeout period.
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/notificaties/{registerId}/messages/{messageId}/{lockToken}':
put:
tags:
- Notificaties
summary: Ontgrendel bericht
operationId: PUT_UnlockBericht
parameters:
- name: registerId
in: path
required: true
schema:
type: string
- name: messageId
in: path
description: ''
required: true
schema:
type: string
- name: lockToken
in: path
description: ''
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: Message successfully unlocked.
headers:
Content-Type:
required: true
schema:
type: string
description: Media-type of the resource
default: application/atom+xml;type=entry;charset=utf-8
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
delete:
tags:
- Notificaties
summary: Verwijder bericht
operationId: DELETE_Bericht
parameters:
- name: registerId
in: path
required: true
schema:
type: string
- name: messageId
in: path
description: ''
required: true
schema:
type: string
- name: lockToken
in: path
description: ''
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: Message successfully deleted.
headers:
Content-Type:
required: true
schema:
type: string
description: Media-type of the resource
default: application/atom+xml;type=entry;charset=utf-8
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningen/{vmswWoningId}/markthuurwaarden':
get:
tags:
- CWR-Markthuurwaarden
description: Markthuurwaarden ophalen voor een woning op basis van het VmswWoningId.
operationId: GET_GeefMarkthuurwaarde
parameters:
- name: vmswWoningId
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MarkthuurwaardeResponse'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningen/markthuurwaarden/simulatie':
post:
tags:
- CWR-Markthuurwaarden
description: Markthuurwaarden berekenen op basis van opgegeven (tijdelijke) woningkenmerkscores. Deze scores worden NIET opgeslagen.
operationId: POST_SimuleerMarkthuurwaarde
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WoningKenmerkScoreLijst'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MarkthuurwaardeSimulatieResponse'
204:
description: No messages available within the specified timeout period.
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningen/{vmswWoningId}/conditiescore':
get:
tags:
- CWR-Conditiescore
description: Conditiescore ophalen voor een woning op basis van het VmswWoningId.
operationId: GET_GeefConditiescore
parameters:
- name: vmswWoningId
in: path
required: true
schema:
type: string
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConditiescoreResponse'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningen/conditiescore/simulatie':
post:
tags:
- CWR-Conditiescore
description: Conditiescore berekenen op basis van opgegeven (tijdelijke) woningkenmerkscores. Deze scores worden NIET opgeslagen.
operationId: POST_SimuleerConditiescore
parameters:
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WoningKenmerkScoreLijst'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConditiescoreSimulatieResponse'
204:
description: No messages available within the specified timeout period.
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
'/socialeHuisvesting/woningen/{vmswWoningId}/energiecorrectie':
get:
tags:
- CWR-Energiecorrectie
description: Energiecorrectie data ophalen voor een woning op basis van het VmswWoningId.
operationId: GET_GeefEnergiecorrectie
parameters:
- name: vmswWoningId
in: path
required: true
schema:
type: string
- name: epcVersie
in: query
required: true
schema:
$ref: '#/components/schemas/EpcVersie'
default: Huidig
- name: datumVanaf
in: query
required: true
schema:
type: string
format: date
- name: datumTot
in: query
required: true
schema:
type: string
format: date
- name: x-correlation-id
in: header
required: true
schema:
$ref: '#/components/schemas/Correlation-Id'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WoningEnergiecorrectieResponse'
400:
description: Validatiefouten
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'
401:
$ref: '#/components/responses/InvalidAuthorization'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/UnexpectedServerError'
502:
$ref: '#/components/responses/BadGateway'
503:
$ref: '#/components/responses/ServiceUnavailable'
504:
$ref: '#/components/responses/GatewayTimeout'
components:
responses:
#HTTP Status 400
BadRequest:
description: "Invalid data supplied"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
#HTTP Status 401
InvalidAuthorization:
description: "Invalid authorization"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
#HTTP Status 403
Forbidden:
description: "Authentication failed"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
#HTTP Status 404
NotFound:
description: "Resource not found"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
#HTTP Status 412
PreConditionFailed:
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
#HTTP Status 500
UnexpectedServerError:
description: "Unexpected Server Error"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
#HTTP Status 502
BadGateway:
description: "Bad Gateway"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
#HTTP Status 503
ServiceUnavailable:
description: "Service unavailable"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
#HTTP Status 504
GatewayTimeout:
description: "Gateway Timeout"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Response:
description: The object containing the result
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
schemas:
Correlation-Id:
description: "ID of the transaction. Use this ID for log tracing and incident handling."
type: string
maxLength: 36
minLength: 10
#----------------------- START CIR payloads to be replaced -------------------------------
DossierDienstZoekCriteria:
type: object
properties:
dossierType:
$ref: '#/components/schemas/RegistrationDossierTypeWaarden'
dossierStatus:
$ref: '#/components/schemas/DossierStatusCodeWaarden'
dossierNummer:
maxLength: 15
type: string
description: Dossiernummer
nullable: true
postCode:
maxLength: 15
type: string
description: Postcode van de personen in het dossier.
nullable: true
aanvragerRijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer van de personen in het dossier.
nullable: true
creatieDatumVanaf:
type: string
description: Vroegste datum waarop het dossier werd aangemaakt.
format: date-time
nullable: true
creatieDatumTot:
type: string
description: Laatste datum waarop het dossier werd aangemaakt.
format: date-time
nullable: true
updateDatumVanaf:
type: string
description: Vroegste datum waarop het dossier werd gewijzigd.
format: date-time
nullable: true
updateDatumTot:
type: string
description: Laatste datum waarop het dossier werd gewijzigd.
format: date-time
nullable: true
ontvangstDatumVanaf:
type: string
description: Vroegste datum waarop het dossier ontvangen werd in het CIR.
format: date-time
nullable: true
ontvangstDatumTot:
type: string
description: Laatste datum waarop het dossier ontvangen werd in het CIR.
format: date-time
nullable: true
nietGesynchroniseerd:
type: boolean
description: >-
Geeft aan of de laatste versie van het dossier reeds werd
gesynchroniseerd.
nullable: true
partijCode:
maxLength: 15
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
additionalProperties: false
nullable: true
DossierDienstZoekResultaat:
type: object
properties:
dossierType:
$ref: '#/components/schemas/RegistrationDossierTypeWaarden'
dossierStatus:
$ref: '#/components/schemas/DossierStatusCodeWaarden'
dossierNummer:
maxLength: 15
type: string
nullable: true
inschrijvingsDatum:
type: string
format: date-time
nullable: true
creatieDatum:
type: string
format: date-time
laatsteWijzigingsDatum:
type: string
format: date-time
nullable: true
voorNaam:
maxLength: 48
type: string
nullable: true
naam:
maxLength: 128
type: string
nullable: true
aanvragerRijksregisternummer:
maxLength: 15
type: string
nullable: true
versieNummer:
type: integer
format: int32
additionalProperties: false
nullable: true
RegistrationDossierTypeWaarden:
enum:
- RFH
- RFM
- VMU
- RMA
type: string
description: >-
<p>Members:</p><ul><li><i>RFH</i>-Aanvraag voor wonen </li >
<li><i>RFM</i>-Interne mutatie aanvraag </li > <li><i>VMU</i>-Verplichte
mutatie </li > <li><i>RMA</i>-Manuele inschrijving </li > </ul>
nullable: true
DossierStatusCodeWaarden:
enum:
- REG
- CHKO
- CHKS
- OFFER
- WAITS
- RJCT
- RFSD
- INFOS
- SAVED
- TEMP
- INFOR
- CHKR
- WAITO
- ARCH
- CNRQ
- AIIR
- TREG
type: string
description: >-
<p>Members:</p><ul><li><i>REG</i>-Ingeschreven </li > <li><i>CHKO</i>-in
onderzoek verhaal </li > <li><i>CHKS</i>-In onderzoek </li >
<li><i>OFFER</i>-In wacht in aanbod </li > <li><i>WAITS</i>-In wacht op
eigen vraag </li > <li><i>RJCT</i>-Geschrapt </li >
<li><i>RFSD</i>-Geweigerd </li > <li><i>INFOS</i>-In onderzoek: extra
info gevraagd </li > <li><i>SAVED</i>-Opgeslagen </li >
<li><i>TEMP</i>-Tijdelijk opgeslagen </li >
<li><i>INFOR</i>-Ingeschreven in onderzoek </li >
<li><i>CHKR</i>-Ingeschreven in onderzoek </li > <li><i>WAITO</i>-in
wacht na aanbod </li > <li><i>ARCH</i>-Gearchiveerd </li >
<li><i>CNRQ</i>-Wachten op dossierdeelname </li > <li><i>AIIR</i>-Extra
inkomen info gevraagd </li > <li><i>TREG</i>-Tijdelijk na registratie
</li > </ul>
nullable: true
DossierDienstZoekResultaten:
type: object
properties:
dossiers:
type: array
items:
$ref: '#/components/schemas/DossierDienstZoekResultaat'
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossier:
type: object
properties:
dossierStatusHistoriek:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierStatusHistoriek'
description: Historiek van Statuswijzigingen
nullable: true
dossierInkomstenSamenvattingen:
$ref: '#/components/schemas/DossierDienstDossierInkomstenSamenvattingen'
dossierPersonen:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierPersoon'
description: Contacten
nullable: true
dossierLocatieVoorkeuren:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierVoorkeurLocatie'
description: Locatie Voorkeuren
nullable: true
dossierOptioneleVoorkeuren:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierOptioneleVoorkeur'
description: Locatie Voorkeuren
nullable: true
dossierEigendommen:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierEigendom'
description: Eigendommen
nullable: true
readOnly: true
dossierDienstDossierDomicilieHistoriek:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierDomiciliePeriode'
description: Domicilie Historiek
nullable: true
readOnly: true
dossierBijlages:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierBijlage'
description: Bijlages
nullable: true
dossierBetrokkenPartijen:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierPartij'
description: Betrokken Partijen (primaire / secundaire verhuurders,...)
nullable: true
bewindvoerder:
$ref: '#/components/schemas/DossierDienstDossierBewindvoerder'
oudDossier:
type: array
items:
$ref: '#/components/schemas/DossierDienstOudDossier'
nullable: true
aanvaardingDossiers:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierComment'
description: Dossier Dienst Dossier Comment
nullable: true
dossierZwarteLijsten:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierZwarteLijst'
description: Dossier Dienst Dossier BlackList
nullable: true
dossierPanden:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierPand'
description: Dossier Dienst Dossier Pand Aanbiedingen
nullable: true
dossierHuidigInkomen:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierHuidigInkomen'
description: Huidig Inkomen
nullable: true
readOnly: true
dossierNummer:
maxLength: 15
type: string
description: DossierNummer
nullable: true
example: 2022.09.07.0019
dossierType:
$ref: '#/components/schemas/RegistrationDossierTypeWaarden'
statusCode:
$ref: '#/components/schemas/DossierStatusCodeWaarden'
woningVoorkeuren:
$ref: '#/components/schemas/DossierDienstDossierVoorkeuren'
inschrijving:
$ref: '#/components/schemas/DossierDienstDossierInschrijving'
schrapping:
$ref: '#/components/schemas/DossierDienstDossierSchrapping'
woningNood:
$ref: '#/components/schemas/DossierDienstDossierWoningNood'
woonsituaties:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierWoonsituatie'
description: Lijst van woonsituaties voor het dossier
nullable: true
readOnly: true
versieNummer:
type: integer
description: Versie nummer van dit dossier
format: int32
example: 3
mogelijkeActies:
type: array
items:
$ref: '#/components/schemas/DossierActieCodeWaarden'
description: mogelijke acties op het dossier
nullable: true
inkomenVoorwaardeStatusCode:
$ref: '#/components/schemas/InkomenVoorwaardeStatusCodeWaarden'
eigendomVoorwaardeStatusCode:
$ref: '#/components/schemas/EigendomVoorwaardeStatusCodeWaarden'
tijdstipLaatsteHandeling:
type: string
description: >-
Tijdstip waarop het dossier het laatste werd behandeld door
Kandidaat-huurder, Woonmaatschappij of automatische actie uit het
CIR.
format: date-time
nullable: true
volmachtWijzigingen:
$ref: '#/components/schemas/RegistratieVolmachtWijzigingenCodeWaarden'
additionalProperties: false
description: Description
nullable: true
DossierDienstDossierStatusHistoriek:
type: object
properties:
statusCodeVan:
$ref: '#/components/schemas/DossierStatusCodeWaarden'
statusCodeTot:
$ref: '#/components/schemas/DossierStatusCodeWaarden'
actie:
$ref: '#/components/schemas/DossierActieWaarden'
statusDatum:
type: string
description: Datum waarop de status van het dossier wijzigde
format: date-time
nullable: true
example: '2022-10-01T09:45:00.000+02:00'
partijCode:
maxLength: 15
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
commentaar:
type: string
description: Notificatie voor gebruiker
nullable: true
additionalProperties: false
description: Historiek van satuswijzigingen
nullable: true
DossierDienstDossierInkomstenSamenvattingen:
type: object
properties:
totaalInkomsten:
type: number
description: Som van alle inkomsten
format: double
nullable: true
totaalInkomstenGeindexeerd:
type: number
description: Geïndexeeerde som van alle inkomsten
format: double
nullable: true
dossierInkomstenSamenvattingen:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierInkomstenSamenvatting'
description: Inkomsten Samenvattingen
nullable: true
readOnly: true
additionalProperties: false
nullable: true
DossierDienstDossierPersoon:
type: object
properties:
contactTypeCode:
$ref: '#/components/schemas/ContactTypeCodeWaarden'
contactAardCode:
$ref: '#/components/schemas/ContactAardCodeWaarden'
geboorteDatum:
type: string
description: Geboortedatum
format: date-time
nullable: true
rijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer
nullable: true
voorNaam:
maxLength: 48
type: string
description: Voornaam van contact/gezinslid
nullable: true
example: Marc
naam:
maxLength: 128
type: string
description: Achternaam van het contact/gezinslid
nullable: true
example: Molenbergs
genderCode:
$ref: '#/components/schemas/GenderCodeWaarden'
burgelijkeStaatCode:
$ref: '#/components/schemas/BurgelijkeStaatCodeWaarden'
mantelzorgGeefCode:
$ref: '#/components/schemas/MantelzorgCodeWaarden'
mantelzorgGeefPostcode:
maxLength: 15
type: string
description: >-
Dit is de postcode van de gemeenten van de derde die mantzorg geeft
van het gezinslid.
nullable: true
mantelzorgKrijgCode:
$ref: '#/components/schemas/MantelzorgCodeWaarden'
mantelzorgKrijgPostcode:
maxLength: 15
type: string
description: >-
Dit is de postcode van de gemeenten van de derde die mantzorg krijgt
van het gezinslid.
nullable: true
taalkennisCode:
$ref: '#/components/schemas/TaalkennisCodeWaarden'
taalkennisSneltestCode:
$ref: '#/components/schemas/TaalkennisSneltestCodeWaarden'
email:
maxLength: 50
type: string
description: E-mailadres van het contact/gezinslid
nullable: true
example: Marc.Molenbergs@hotmail.be
telefoon1:
maxLength: 15
type: string
description: Telefoonnummer van het contact/gezinslid
nullable: true
example: 015/43 43 43
telefoon2:
maxLength: 15
type: string
description: Telefoonnummer van het contact/gezinslid
nullable: true
example: 0477 / 43 43 43
adressen:
$ref: '#/components/schemas/DossierDienstDossierPersoonAdressen'
beperkingMutualiteitErkenningCode:
$ref: '#/components/schemas/BeperkingMutualiteitErkenningCodeWaarden'
verblijfsAdresCode:
$ref: '#/components/schemas/VerblijfsAdresCodeWaarden'
contactInvaliditeitCode:
$ref: '#/components/schemas/ContactInvaliditeitCodeWaarden'
werkzaamheidGeschiedenisCode:
$ref: '#/components/schemas/WerkzaamheidGeschiedenisCodeWaarden'
contactSubTypeCode:
$ref: '#/components/schemas/ContactSubTypeCodeWaarden'
contactAantalKinderenCode:
$ref: '#/components/schemas/ContactAantalKinderenCodeWaarden'
contactPersoonTenLaste:
$ref: '#/components/schemas/RegistratieContactPersoonTenLaste'
contactErkenningAfhankelijk:
type: array
items:
$ref: '#/components/schemas/RegistratieContactErkenningAfhankelijk'
description: Geeft aan of de financiële afhankelijkheid erkend is
nullable: true
example:
- LLFP
- BLIND
- ULAM
- ULPA
registratieContactErkenningInformatieVoorKind:
type: string
description: Bijkomende info uit ksz rond handicap
nullable: true
registratieContactErkenningInformatieVoorVolwassenen:
type: string
description: Bijkomende info uit ksz rond handicap
nullable: true
bewindvoerderCode:
$ref: '#/components/schemas/RegistratieContactBewindvoerderCode'
bewindvoerderRijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer van bewindvoerder (indien bekend)
nullable: true
example: '2209280001'
verbondenAanVennootschap:
$ref: '#/components/schemas/RegistratieContactVerbondenAanVennootschap'
additionalProperties: false
nullable: true
DossierDienstDossierVoorkeurLocatie:
type: object
properties:
gemeenteNisCode:
maxLength: 15
type: string
description: >-
Geeft de NIScode van de gemeente weer, waar de Kandidaat-huurder wil
wonen.
nullable: true
example: '41002'
wijken:
maxLength: 3000
type: string
description: >-
Geeft de wijk van de gemeente/deelgemeenten weer, waar de
Kandidaat-huurder wil wonen.
nullable: true
example: Ajoin Koté,Amylum Waik
sorteerIndex:
type: integer
description: Sortering van de vragen
format: int32
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierOptioneleVoorkeur:
type: object
properties:
partijCode:
maxLength: 15
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
example: '5025'
optioneleVoorkeurVraagCode:
$ref: '#/components/schemas/OptioneleVoorkeurVraagCodeWaarden'
optioneleVoorkeurAntwoordCode:
maxLength: 5
type: string
description: Geeft het antwoord op de optionele voorkeurvragen
nullable: true
example: 'YES'
additionalProperties: false
nullable: true
DossierDienstDossierEigendom:
type: object
properties:
rijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer gekoppeld aan een eigendom.
nullable: true
eigendomTypeCode:
$ref: '#/components/schemas/EigendomTypeCodeWaarden'
eigendomAardCode:
$ref: '#/components/schemas/EigendomAardCodeWaarden'
waarde:
maxLength: 15
type: string
description: Het percentage van de woning die de persoon bezit.
nullable: true
perceelID:
maxLength: 50
type: string
description: Perceel identificatie
nullable: true
justificatie:
type: string
description: Opmerking van KH bij een gekende eigendom
nullable: true
justificatieDeclaratie:
type: string
description: Opmerking van KH bij het aangeven van een eigendom
nullable: true
straat:
maxLength: 100
type: string
description: Straatnaam van het onroerend goed
nullable: true
huisNummer:
maxLength: 12
type: string
description: Huisnummer van het onroerend goed
nullable: true
gemeente:
maxLength: 100
type: string
description: Gemeente waarin het onroerend goed zich bevindt
nullable: true
postCode:
maxLength: 15
type: string
description: Postcode van de gemeente waarin het onroerend ged zich bevindt
nullable: true
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode van de gemeente waarin het onroerend ged zich bevindt
nullable: true
landCode:
maxLength: 5
type: string
description: Code van het land waar het onroerend ged zich bevindt
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierDomiciliePeriode:
type: object
properties:
landCode:
maxLength: 5
type: string
description: Code van het land waar het gezinslid verbleef
nullable: true
rijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer gekoppeld aan een dossier.
nullable: true
example: '2209280001'
postCode:
maxLength: 15
type: string
description: Postcode van het adress waar het gezinslid verbleef.
nullable: true
gemeente:
maxLength: 100
type: string
description: Gemeente het gezinslid verbleef.
nullable: true
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode van de gemeente waar het gezinslid verbleef
nullable: true
straat:
maxLength: 50
type: string
description: Straat het gezinslid verbleef.
nullable: true
huisNummer:
maxLength: 15
type: string
description: Huisnummer van de woning waarin het gezinslid verbleef.
nullable: true
huisNummerBus:
maxLength: 5
type: string
description: Busnummer van de woning waarin het gezinslid verbleef
nullable: true
beginDatum:
type: string
description: Begindatum vanaf wanneer het gezinslid in de woning verbleef
format: date-time
example: '2022-09-25'
eindDatum:
type: string
description: "Einddatum tot wanneer het geznslid in de woning verbleef\r\nEinddatum tot wanneer het geznslid in de woning verbleef"
format: date-time
nullable: true
example: '2022-09-28'
additionalProperties: false
nullable: true
DossierDienstDossierBijlage:
type: object
properties:
bestandNaam:
maxLength: 225
type: string
description: Naam van het bestand
nullable: true
bestandGrootte:
type: integer
description: Grootte van het bestand
format: int32
nullable: true
bestandExtensieCode:
$ref: '#/components/schemas/BestandExtensieCodeWaarden'
identificatie:
maxLength: 225
type: string
description: Identificatie naam van de bijlage
nullable: true
indentificatieRijksregisternummer:
maxLength: 15
type: string
description: RRN van persoon die het bestand opgeladen heeft
nullable: true
identificatieBestandCode:
$ref: '#/components/schemas/IdentificatieBestandCodeWaarden'
identificatieBestandIndex:
type: integer
format: int32
bestand:
type: string
description: Het effectieve bestand zelf
nullable: true
opmerking:
type: string
description: Opmerkingen die bij het bestand kunnen worden toegevoed\
nullable: true
bijlageDatum:
type: string
description: Datum waarop de bijlage werd toegevoegd
format: date-time
aanvaardingBijlageCode:
$ref: '#/components/schemas/AanvaardingBijlageCodeWaarden'
additionalProperties: false
nullable: true
DossierDienstDossierPartij:
type: object
properties:
partijTypeCode:
$ref: '#/components/schemas/DossierPartijTypeCodeWaarden'
partijRolCode:
$ref: '#/components/schemas/DossierPartijRolCodeWaarden'
partijIdentificatie:
type: string
description: >-
Ondernemingsnummer van de woonmaatschappij, rijksregisternummer voor
kandidaat-huurder.
nullable: true
postCode:
maxLength: 15
type: string
description: Hoofdzetel van de woonmaatschappij.
nullable: true
example: '2830'
gemeente:
maxLength: 100
type: string
description: Gemeente van de hoofdzetel van de woonmaatschappij
nullable: true
example: Willebroek
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode van de gemeente van de betrokken partij
nullable: true
straat:
maxLength: 100
type: string
description: Straat van de hoofdzetel van de woonmaatschappij.
nullable: true
example: Bos
huisNummer:
maxLength: 12
type: string
description: Nummer van de hoofdzetel van de woonmaatschappij.
nullable: true
example: '502'
huisNummerBus:
maxLength: 10
type: string
description: Busnummer van de hoofdzetel van de woonmaatschappij.
nullable: true
example: X
additionalProperties: false
description: Alle betrokken partijen(primaire/secundaire verhuurders)
nullable: true
DossierDienstDossierBewindvoerder:
type: object
properties:
rijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer van bewindgevoerde
nullable: true
example: '2209280001'
voorNaam:
maxLength: 48
type: string
description: Voornaam van bewindvoerder
nullable: true
example: Marc
naam:
maxLength: 128
type: string
description: Achternaam van bewindvoerder
nullable: true
example: Molenbergs
email:
maxLength: 50
type: string
description: E-mailadres van bewindvoerder
nullable: true
example: Marc.Molenbergs@hotmail.be
telefoon1:
maxLength: 15
type: string
description: Telefoonnummer van bewindvoerder
nullable: true
example: 015/43 43 43
telefoon2:
maxLength: 15
type: string
description: Telefoonnummer van bewindvoerder
nullable: true
example: 0477 / 43 43 43
postCode:
maxLength: 15
type: string
description: Postcode van de domicilie van bewindvoerder
nullable: true
example: '2830'
gemeente:
maxLength: 100
type: string
description: Naam van de gemeente van bewindvoerder
nullable: true
example: Willebroek
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode
nullable: true
example: 41002A
landCode:
maxLength: 5
type: string
nullable: true
straat:
maxLength: 100
type: string
description: Straat van bewindvoerder
nullable: true
example: Bos
huisNummer:
maxLength: 12
type: string
description: Huisnummer van bewindvoerder
nullable: true
example: '502'
huisNummerBus:
maxLength: 10
type: string
description: Bus nr van bewindvoerder
nullable: true
example: X
additionalProperties: false
nullable: true
DossierDienstOudDossier:
type: object
properties:
oudDossierNummer:
maxLength: 250
type: string
nullable: true
example: '2022.03.25.0001 '
partijCode:
maxLength: 15
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
example: '3343'
additionalProperties: false
nullable: true
DossierDienstDossierComment:
type: object
properties:
aanvaardingTypeCode:
$ref: '#/components/schemas/AanvaardingDossierTypeCode'
aanvaardingCode:
$ref: '#/components/schemas/AanvaardingDossierCode'
opmerking:
type: string
description: opmerking aanvaarding
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierZwarteLijst:
type: object
properties:
partijIdentificatie:
maxLength: 15
type: string
description: Rijksregisternummer van kandidaat-hurder/ gezinslid
nullable: true
reden:
$ref: '#/components/schemas/ZwarteLijstRedenCodeWaarden'
datum:
type: string
description: Datum waarop de persoon op de zwarte lijst werd gezet
format: date-time
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierPand:
type: object
allOf:
- $ref: '#/components/schemas/DossierDienstDossierPandUpdate'
properties:
pandAanbiedingStatus:
$ref: '#/components/schemas/DossierPandAanbiedingStatusCodeWaarden'
partijCode:
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
example: '1234'
aanbiedingsDatum:
type: string
description: Datum van aanmaak van de aanbieding
format: date-time
nullable: true
statusDatum:
type: string
description: Datum (laatste) status wijziging
format: date-time
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierHuidigInkomen:
type: object
properties:
rijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer gekoppeld aan een dossier.
nullable: true
authentiekebron:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierIncomeAuthentiekebron'
nullable: true
gewerktLaatste6Maand:
type: string
description: >-
Geeft per maand aan of de kandidaat-huurder werkte of niet (t= heeft
gewerkt, f= heeft niet gewerkt).
nullable: true
example: T;F;T;F;T;F
schuldenregeling:
$ref: '#/components/schemas/SchuldenregelingCodeWaarden'
onderhoudsgelden:
$ref: '#/components/schemas/OnderhoudsgeldenCodeWaarden'
additionalProperties: false
nullable: true
GenderCodeWaarden:
enum:
- MAN
- VROUW
- X
type: string
description: >-
Gender Code (GNDR)<p>Members:</p><ul><li><i>MAN</i>-Mannelijk </li >
<li><i>VROUW</i>-Vrouwelijk </li > <li><i>X</i>-Onbekend </li > </ul>
nullable: true
DossierDienstDossierVoorkeuren:
type: object
properties:
maximaalHuurBedrag:
type: integer
description: Maximale huurbedrag die de kandidaathuurder wenst te betalen
format: int32
nullable: true
maximaalHuurLast:
type: integer
description: Maximale huurlast die de kandidaathuurder wenst te betalen
format: int32
nullable: true
example: 500
minimumAantalKamers:
type: integer
description: Het minimaal aantal kamers die het gezin wenst
format: int32
nullable: true
example: 2
maximumAantalKamers:
type: integer
description: Het maximaal aantal kamers die het gezin wenst
format: int32
nullable: true
example: 3
woningTypeCode:
type: array
items:
$ref: '#/components/schemas/WoningTypeCodeWaarden'
description: Type van de woning die het gezin wenst
nullable: true
example:
- H
lichamelijkeBeperkingCode:
$ref: '#/components/schemas/LichamelijkeBeperkingCodeWaarden'
additionalProperties: false
description: Woning voorkeuren voor het dossier
nullable: true
DossierDienstDossierInschrijving:
type: object
properties:
hulpCode:
$ref: '#/components/schemas/InschrijfhulpCodeWaarden'
hulpInformerenCode:
$ref: '#/components/schemas/InschrijfhulpInformerenCodeWaarden'
hulpNaam:
type: string
description: Naam van organisatie die KH hielp inschrijven
nullable: true
hulpEmail:
maxLength: 50
type: string
description: Email adress van inschrijfhulp
nullable: true
example: een.goed.mens@live.be
datum:
type: string
description: Eerste indieningsdatum van het dossier
format: date-time
nullable: true
additionalProperties: false
description: Inschrijvings data van het dossier
nullable: true
DossierDienstDossierSchrapping:
type: object
properties:
datum:
type: string
description: Datum van schrapping van het dossier
format: date-time
nullable: true
redenCode:
$ref: '#/components/schemas/SchrappingRedenCodeWaarden'
additionalProperties: false
description: Schrapping informatie binnen het dossier
nullable: true
DossierDienstDossierWoningNood:
type: object
properties:
redenCode:
$ref: '#/components/schemas/WoningnoodRedenEnumCode'
omschrijving:
type: string
description: Woningnood reden omschrijving
nullable: true
indentificatie:
type: string
description: Identificatie van de woonnood
nullable: true
additionalProperties: false
description: Woningnood voor het dossier
nullable: true
DossierActieCodeWaarden:
enum:
- OFFER
- CCL
- OBJCT
- REQI
- REF
- RJCT
- WAIT
- WAKE
- VOL
- ACC
- APP
- ARCH
- FRAUD
- DEC
- NCOMP
- NORES
- OVRVW
- REG
- RSPND
- SAVE
- UNDO
- ACTUA
- MIGRA
- NOACT
- CCLGW
- NOCOMP
- CONF
- UNDNR
- UNDRF
- OND
type: string
description: >-
nvarchar(5)<p>Members:</p><ul><li><i>OFFER</i>-Aanbod Maken </li >
<li><i>CCL</i>-Annuleren </li > <li><i>OBJCT</i>-Annuleren </li >
<li><i>REQI</i>-Bijkomende informatie vragen </li >
<li><i>REF</i>-Weigeren </li > <li><i>RJCT</i>-Afwijzen </li >
<li><i>WAIT</i>-In wacht zetten </li > <li><i>WAKE</i>-Uit wacht halen
</li > <li><i>VOL</i>-vrijwillig vertrekken </li > <li><i>ACC</i>-Aanbod
geaccepteerd </li > <li><i>APP</i>-Van toepassing zijn </li >
<li><i>ARCH</i>-Archief </li > <li><i>FRAUD</i>-frauduleus </li >
<li><i>DEC</i>-Overleden </li > <li><i>NCOMP</i>-Niet-conform </li >
<li><i>NORES</i>-Geen antwoord </li > <li><i>OVRVW</i>-Overzicht </li >
<li><i>REG</i>-Register </li > <li><i>RSPND</i>-Antwoorden </li >
<li><i>SAVE</i>-Opslaan </li > <li><i>UNDO</i>-Ga terug naar de vorige
echte staat </li > <li><i>ACTUA</i>-Actualisatie </li >
<li><i>MIGRA</i>-Via de actualisatie zijn wijzigingen aangebracht </li >
<li><i>NOACT</i>-Actie na 2 jaar inactiviteit </li >
<li><i>CCLGW</i>-Gegronde weigering door kandidaat-huurder na aanbod
</li > <li><i>NOCOMP</i>-Schrapping door niet voldoen
inschrijvingsvoorwaarde </li > <li><i>CONF</i>-Bevestigen van dossier na
migratie </li > <li><i>UNDNR</i>-Ongedaan maken van vroegere niet
reactie </li > <li><i>UNDRF</i>-Ongedaan maken van vroegere weigering
</li > <li><i>OND</i>-Schrapping door ontdubbeling </li > </ul>
nullable: true
InkomenVoorwaardeStatusCodeWaarden:
enum:
- EI
- MCN
- OK
type: string
description: >-
Resultaat van de automatische
controle<p>Members:</p><ul><li><i>EI</i>-Er is extra informatie nodig
</li > <li><i>MCN</i>-Er kan momenteel geen controle uitgevoerd worden
</li > <li><i>OK</i>-U Voldoet </li > </ul>
nullable: true
EigendomVoorwaardeStatusCodeWaarden:
enum:
- MCN
- OK
type: string
description: >-
Resultaat van de automatische
controle<p>Members:</p><ul><li><i>MCN</i>-Er kan momenteel geen controle
uitgevoerd worden </li > <li><i>OK</i>-U Voldoet </li > </ul>
nullable: true
RegistratieVolmachtWijzigingenCodeWaarden:
enum:
- 'NO'
- 'YES'
- 'UNK'
type: string
description: >-
<p>Members:</p><ul>
<li><i>NO</i>-Primaire woonmaatschappij mag geen aanpassingen doen op vraag van de KH.</li >
<li><i>YES</i>-Primaire woonmaatschappij mag aanpassingen doen op vraag van de KH.</li >
<li><i>UNK</i>-Onbekend</li ></ul>
nullable: true
DossierActieWaarden:
enum:
- OFFER
- CCL
- OBJCT
- REQI
- REF
- RJCT
- WAIT
- WAKE
- VOL
- ACC
- APP
- ARCH
- FRAUD
- DEC
- NCOMP
- NORES
- OVRVW
- REG
- RSPND
- SAVE
- UNDO
- ACTUA
- MIGRA
- NOACT
- CCLGW
- NOCOMP
- CONF
- UNDNR
- UNDRF
- OND
type: string
description: >-
<p>Members:</p><ul><li><i>OFFER</i>-Aanbod Maken </li >
<li><i>CCL</i>-Annuleren </li > <li><i>OBJCT</i>-Annuleren </li >
<li><i>REQI</i>-Bijkomende informatie vragen </li >
<li><i>REF</i>-Weigeren </li > <li><i>RJCT</i>-Afwijzen </li >
<li><i>WAIT</i>-In wacht zetten </li > <li><i>WAKE</i>-Uit wacht halen
</li > <li><i>VOL</i>-vrijwillig vertrekken </li > <li><i>ACC</i>-Aanbod
geaccepteerd </li > <li><i>APP</i>-Van toepassing zijn </li >
<li><i>ARCH</i>-Archief </li > <li><i>FRAUD</i>-frauduleus </li >
<li><i>DEC</i>-Overleden </li > <li><i>NCOMP</i>-Niet-conform </li >
<li><i>NORES</i>-Geen antwoord </li > <li><i>OVRVW</i>-Overzicht </li >
<li><i>REG</i>-Register </li > <li><i>RSPND</i>-Antwoorden </li >
<li><i>SAVE</i>-Opslaan </li > <li><i>UNDO</i>-Ga terug naar de vorige
echte staat </li > <li><i>ACTUA</i>-Actualisatie </li >
<li><i>MIGRA</i>-Via de actualisatie zijn wijzigingen aangebracht </li >
<li><i>NOACT</i>-Actie na 2 jaar inactiviteit </li >
<li><i>CCLGW</i>-Gegronde weigering door kandidaat-huurder na aanbod
</li > <li><i>NOCOMP</i>-Schrapping door niet voldoen
inschrijvingsvoorwaarde </li > <li><i>CONF</i>-Bevestigen van dossier na
migratie </li > <li><i>UNDNR</i>-Ongedaan maken van vroegere niet
reactie </li > <li><i>UNDRF</i>-Ongedaan maken van vroegere weigering
</li > <li><i>OND</i>-Schrapping door ontdubbeling </li > </ul>
nullable: true
DossierDienstDossierInkomstenSamenvatting:
type: object
properties:
inkomstenJaar:
type: string
description: Jaar van het referentie-inkomen
nullable: true
example: '2022'
belastbaarInkomenAanwezigheidCode:
$ref: '#/components/schemas/BelastbaarInkomenAanwezigheidCodeWaarden'
belastbaarInkomenJaarTotaal:
type: number
description: >-
Geeft aan hoeveel het totale belastbare inkomen bedraagt op
jaarbasis.
format: double
nullable: true
example: 12345
leefLoonAanwezigheidCode:
$ref: '#/components/schemas/LeefLoonAanwezigheidCodeWaarden'
leefLoonJaarTotaal:
type: number
description: Geeft aan hoeveel het totale leefloon bedraagt op jaarbasis.
format: double
nullable: true
example: 12345
inkomensVervangendeTegemoetkomingCode:
$ref: '#/components/schemas/InkomensVervangendeTegemoetkomingCodeWaarden'
inkomensVervangendeTegemoetkomingJaarTotaal:
type: number
description: >-
Dit is de intensiteit/aard van verblijf dat het gezinslid zal hebben
in de sociale woning.
format: double
nullable: true
example: 12345
inkomensPensioenJaarTotaal:
type: number
description: Geeft aan hoeveel pensioen het gezinslid krijgt
format: double
nullable: true
example: 12345
extraBeroepsBuitenlandInkomstenJaarTotaal:
type: number
description: Geeft het niet geïndexeerde bedrag van het buitenlandsinkomen
format: double
nullable: true
extraBeroepsInstellingenInkomenstenJaarTotaal:
type: number
description: >-
Geeft het niet-geïndexeerde inkomensbedrag uit Europese of
internationale instellingen
format: double
nullable: true
rijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer gekoppeld aan een dossier.
nullable: true
additionalProperties: false
nullable: true
ContactTypeCodeWaarden:
enum:
- _1
- _2
- _3
- _4
- _5
- _6
- _7
- _8
- _9
- _10
- _11
- _12
- _13
- _14
- _15
- _16
- _17
- _20
- _21
- _22
- _23
- _50
- _51
- _0
type: string
description: >-
Contact Type Code
(RCTPL)<p>Members:</p><ul><li><i>_1</i>-Referentiepersoon </li >
<li><i>_2</i>-Echtgenoot, Echtgenote </li > <li><i>_3</i>-Zoon, Dochter
</li > <li><i>_4</i>-Schoonzoon, Schoondochter </li >
<li><i>_5</i>-Kleinzoon, Kleindochter </li > <li><i>_6</i>-Vader, Moeder
</li > <li><i>_7</i>-Schoonvader, Schoonmoeder </li >
<li><i>_8</i>-Grootvader, Grootmoeder </li > <li><i>_9</i>-Broer, Zuster
</li > <li><i>_10</i>-Schoonbroer, Schoonzuster </li >
<li><i>_11</i>-Verwant, Verwante </li > <li><i>_12</i>-Zonder
familieverband </li > <li><i>_13</i>-Stiefzoon, Stiefdochter </li >
<li><i>_14</i>-Achterkleinzoon, Achterkleindochter </li >
<li><i>_15</i>-Tante, Oom </li > <li><i>_16</i>-Nicht, Neef
(verwantschap: 3de graad) </li > <li><i>_17</i>-Nicht, Neef
(verwantschap: 4de graad) </li > <li><i>_20</i>-Gemeenschappen, tehuizen
</li > <li><i>_21</i>-Partner </li > <li><i>_22</i>-Wettelijk
samenwonende </li > <li><i>_23</i>-Meemoederschap </li >
<li><i>_50</i>-SamenwonendePartner </li > <li><i>_51</i>-Samenwonend
</li > <li><i>_0</i>-Onbekend </li > </ul>
nullable: true
ContactAardCodeWaarden:
enum:
- DOM
- COP
- VRO
- OTH
- SDD
type: string
description: >-
Contact Aard Code
(RCRT)<p>Members:</p><ul><li><i>DOM</i>-Inwonend(domicilie) </li >
<li><i>COP</i>-Co-ouderschap </li > <li><i>VRO</i>-Bezoekrecht met
overnachting </li > <li><i>OTH</i>-Ander soort duurzaam verblijf </li >
<li><i>SDD</i>-Kind gedomicilieerd in buitenland </li > </ul>
nullable: true
BurgelijkeStaatCodeWaarden:
enum:
- _10
- _20
- _25
- _26
- _30
- _40
- _41
- _50
- _51
- _60
- _80
- _81
- _90
- _95
- _96
- _97
- _98
type: string
description: >-
Burgelijke Staat<p>Members:</p><ul><li><i>_10</i>-Ongehuwd </li >
<li><i>_20</i>-Gehuwd </li > <li><i>_25</i>-Nietigverklaring van het
huwelijk </li > <li><i>_26</i>-Putatief huwelijk </li >
<li><i>_30</i>-Weduwenaar </li > <li><i>_40</i>-Echtgescheiden </li >
<li><i>_41</i>-Echtscheiding uitgesproken met toepassing van de wet van
30 juni 1994 </li > <li><i>_50</i>-Scheiding van tafel en bed en van
goederen </li > <li><i>_51</i>-Scheiding van tafel en bed en van
goederen uitgesproken met toepassing van de wet van 30 juni 1994 </li >
<li><i>_60</i>-Ontbinding van het huwelijk op een bijzondere wijze </li
> <li><i>_80</i>-Partnerschap </li > <li><i>_81</i>-Beëindiging
partnerschap </li > <li><i>_90</i>-Onbepaald </li > <li><i>_95</i>-Op
verklaring zonder bewijs - Ongehuwd </li > <li><i>_96</i>-Op verklaring
zonder bewijs - Gehuwd </li > <li><i>_97</i>-Op verklaring zonder bewijs
– Gescheiden </li > <li><i>_98</i>-Op verklaring zonder bewijs – Weduwe
(naar) </li > </ul>
nullable: true
MantelzorgCodeWaarden:
enum:
- 'NO'
- CARER
- CAREG
type: string
description: >-
Mantelzorg Code (CARE)<p>Members:</p><ul><li><i>NO</i>-Geen Manterzorg
</li > <li><i>CARER</i>-Krijgt mantelzorg </li > <li><i>CAREG</i>-Geeft
mantelzorg </li > </ul>
nullable: true
TaalkennisCodeWaarden:
enum:
- NA
- 'NO'
- 'YES'
type: string
description: >-
Resultaat van authentieke
bron<p>Members:</p><ul><li><i>NA</i>-Taalkennis kan niet gecontroleerd
worden </li > <li><i>NO</i>-Taalkennis niet in orde </li >
<li><i>YES</i>-Taalkennis in orde </li > </ul>
nullable: true
TaalkennisSneltestCodeWaarden:
enum:
- 'NO'
- 'YES'
type: string
description: >-
<p>Members:</p><ul><li><i>NO</i>-Taalkennis niet in orde </li >
<li><i>YES</i>-Taalkennis in orde </li > </ul>
nullable: true
DossierDienstDossierPersoonAdressen:
type: object
properties:
contactVoorkeurCode:
$ref: '#/components/schemas/ContactVoorkeurCodeWaarden'
domicilie:
$ref: '#/components/schemas/DossierDienstDossierPersoonAdresDomicilie'
verblijf:
$ref: '#/components/schemas/DossierDienstDossierPersoonAdresVerblijf'
contact:
$ref: '#/components/schemas/DossierDienstDossierPersoonAdresContact'
additionalProperties: false
nullable: true
BeperkingMutualiteitErkenningCodeWaarden:
enum:
- 'NO'
- 'YES'
type: string
description: >-
Beperking Mutualiteit Erkenning Code
(RRBM)<p>Members:</p><ul><li><i>NO</i>-Geen beperking erkend door
mutualiteit </li > <li><i>YES</i>-Beperking erkend door mutualiteit </li
> </ul>
nullable: true
VerblijfsAdresCodeWaarden:
enum:
- DOM
- ALT
type: string
description: >-
Verblijfs Adres Code (RADR)<p>Members:</p><ul><li><i>DOM</i>-Domicilie
Adress </li > <li><i>ALT</i>-Verblijfs Adress </li > </ul>
nullable: true
ContactInvaliditeitCodeWaarden:
enum:
- NINV
- INV
type: string
description: >-
Contact Invaliditeit Code (RCNV)<p>Members:</p><ul><li><i>NINV</i>-Geen
invaliditeit geregistreerd </li > <li><i>INV</i>-Invalidateit gekend en
geregistreerd </li > </ul>
nullable: true
WerkzaamheidGeschiedenisCodeWaarden:
enum:
- Y6M
- N6M
- NA
type: string
description: >-
Werkzaamheid Geschiedenis Code
(RCLH)<p>Members:</p><ul><li><i>Y6M</i>-Heeft de afgelopen 6 maanden
gewerkt </li > <li><i>N6M</i>-Heeft de afgelopen 6 maanden niet gewerkt
</li > <li><i>NA</i>-Niet ingevuld </li > </ul>
nullable: true
ContactSubTypeCodeWaarden:
enum:
- PRGA
- PRT
- REU
- SOJ
type: string
description: >-
Contact Sub Type Code
(RCSU)<p>Members:</p><ul><li><i>PRGA</i>-Zwangerschap / Adoptie </li >
<li><i>PRT</i>-Partner </li > <li><i>REU</i>-Familie hereniging </li >
<li><i>SOJ</i>-Sojourner </li > </ul>
nullable: true
ContactAantalKinderenCodeWaarden:
enum:
- ONE
- TWO
- THRIM
type: string
description: >-
Contact Aantal Kinderen Code (RCNC)<p>Members:</p><ul><li><i>ONE</i>-Een
</li > <li><i>TWO</i>-Twee </li > <li><i>THRIM</i>-Drie of meer </li >
</ul>
nullable: true
RegistratieContactPersoonTenLaste:
enum:
- DEP
- DDEP
type: string
description: >-
<p>Members:</p><ul><li><i>DEP</i>-Ten laste </li >
<li><i>DDEP</i>-Dubbel ten laste </li > </ul>
nullable: true
RegistratieContactErkenningAfhankelijk:
enum:
- LLFP
- BLIND
- ULAM
- ULPA
type: string
description: >-
<p>Members:</p><ul><li><i>LLFP</i>-Onderste ledenmaten vijftig percent
</li > <li><i>BLIND</i>-Volledige blindheid </li >
<li><i>ULAM</i>-Bovenste ledenmaten geamputeerd </li >
<li><i>ULPA</i>-upper limbs paralysed </li > </ul>
nullable: true
RegistratieContactBewindvoerderCode:
enum:
- 'YES'
- UNK
type: string
description: >-
<p>Members:</p><ul><li><i>YES</i>-Onder bewindvoering </li >
<li><i>UNK</i>-Niet gekend </li > </ul>
nullable: true
RegistratieContactVerbondenAanVennootschap:
enum:
- 'NO'
- 'YES'
- UNK
type: string
description: >-
<p>Members:</p><ul><li><i>NO</i>-Kandidaat-huurder is niet verbonden aan
een vennootschap </li > <li><i>YES</i>-Kandidaat-huurder is verbonden
aan een vennootschap </li > <li><i>UNK</i>-Onbekend </li > </ul>
nullable: true
OptioneleVoorkeurVraagCodeWaarden:
enum:
- OPHV
- OPST
- OPKO
- OPLT
- OPTR
- OPDN
- OPWM
type: string
description: >-
<p>Members:</p><ul><li><i>OPHV</i>-Hoogste verdieping waar je wilt
wonen? </li > <li><i>OPST</i>-Zijn traptreden in het gebouw of de woning
een probleem? </li > <li><i>OPKO</i>-Heb je een kamer op overschot
nodig? </li > <li><i>OPLT</i>-Heb je een lift nodig? </li >
<li><i>OPTR</i>-Heb je een terras nodig? </li > <li><i>OPDN</i>-Heb je
een douche nodig? </li > <li><i>OPWM</i>-Heb je een aansluiting voor een
wasmachine nodig? </li > </ul>
nullable: true
EigendomTypeCodeWaarden:
enum:
- BLE
- BEBW
- BEEP
- BEGB
- BEGK
- BEOP
- BEW
- EP
- EVG
- BAT
- GB
- GK
- SOL
- ONB
- OP
- OPEP
- VE
- VEBW
- VEEP
- VEGB
- VEGK
- VEOP
- VG
- VGBW
- VGEP
- VGGB
- VGGK
- VGOP
- JUST
type: string
description: >-
Eigendom Type (= Recht Aard) Code
(ROTP)<p>Members:</p><ul><li><i>BLE</i>-Blote eigendom </li >
<li><i>BEBW</i>-Blote eigendom bezwaard met een recht van bewoning </li
> <li><i>BEEP</i>-Blote eigendom bezwaard met een recht van erfpacht
</li > <li><i>BEGB</i>-Blote eigendom bezwaard met een recht van gebruik
en bewoning </li > <li><i>BEGK</i>-Blote eigendom bezwaard met een recht
van gebruik </li > <li><i>BEOP</i>-Blote eigendom bezwaard met een recht
van opstal </li > <li><i>BEW</i>-Bewoning </li > <li><i>EP</i>-Erfpacht
</li > <li><i>EVG</i>-Eventueel vruchtgebruik </li >
<li><i>BAT</i>-Gebouw </li > <li><i>GB</i>-Gebruik en bewoning </li >
<li><i>GK</i>-Gebruik </li > <li><i>SOL</i>-Eigenaar grond </li >
<li><i>ONB</i>-Onbekend recht </li > <li><i>OP</i>-Opstal </li >
<li><i>OPEP</i>-Opstal bezwaard met een recht van erfpacht </li >
<li><i>VE</i>-Volle eigendom </li > <li><i>VEBW</i>-Volle eigendom
bezwaard met een recht van bewoning </li > <li><i>VEEP</i>-Volle
eigendom bezwaard met een recht van erfpacht </li >
<li><i>VEGB</i>-Volle eigendom bezwaard met een recht van gebruik en
bewoning </li > <li><i>VEGK</i>-Volle eigendom bezwaard met een recht
van gebruik </li > <li><i>VEOP</i>-Volle eigendom bezwaard met een recht
van opstal </li > <li><i>VG</i>-Vruchtgebruik </li >
<li><i>VGBW</i>-Vruchtgebruik bezwaard met een recht van bewoning </li >
<li><i>VGEP</i>-Vruchtgebruik bezwaard met een recht van erfpacht </li >
<li><i>VGGB</i>-Vruchtgebruik bezwaard met een recht van gebruik en
bewoning </li > <li><i>VGGK</i>-Vruchtgebruik bezwaard met een recht van
gebruik </li > <li><i>VGOP</i>-Vruchtgebruik bezwaard met een recht van
opstal </li > <li><i>JUST</i>-Code voor extra justificatie of
justificatiedeclaratie </li > </ul>
nullable: true
EigendomAardCodeWaarden:
enum:
- APP
- TERRB
- HOME
- CONS
- HAYF
- MEAD
- TRADH
- HOTEL
- STD
- RM
type: string
description: >-
Eigendom Aard Code (ROKD)<p>Members:</p><ul><li><i>APP</i>-Appartement
</li > <li><i>TERRB</i>-Bouwgrond </li > <li><i>HOME</i>-Huis </li >
<li><i>CONS</i>-Bouwland </li > <li><i>HAYF</i>-Hooiland </li >
<li><i>MEAD</i>-Weiland </li > <li><i>TRADH</i>-Handelshuis </li >
<li><i>HOTEL</i>-Hotel </li > <li><i>STD</i>-Studio </li >
<li><i>RM</i>-Kamer </li > </ul>
nullable: true
BestandExtensieCodeWaarden:
enum:
- JPG
- JPEG
- TIF
- TIFF
- PDF
- PNG
- GIF
type: string
description: >-
<p>Members:</p><ul><li><i>JPG</i>-Jpeg </li > <li><i>JPEG</i>-Jpeg </li
> <li><i>TIF</i>-Tagged Image File Format </li > <li><i>TIFF</i>-Tagged
Image File Format </li > <li><i>PDF</i>-Acrobat Reader </li >
<li><i>PNG</i>-Portable Network Graphic </li > <li><i>GIF</i>-Afbeelding
</li > </ul>
nullable: true
IdentificatieBestandCodeWaarden:
enum:
- DM
- CCTS
- CCPD
- CFR
- CPA
- INCA
- INCE
- INCPS
- INCYB
- INCYM
- INCNB
- INCNM
- PRF
- OWN
- REJUU
- REJUS
- HONE
- CRCV
- CGIV
- PROXY
type: string
description: >-
Identificatie Bestand Code<p>Members:</p><ul><li><i>DM</i>-Bijlage rond
arbeidsongeschiktheid (wederzijds) </li > <li><i>CCTS</i>-Bijlage rond
type verblijf </li > <li><i>CCPD</i>-Bijlage rond lichamelijke of
geestelijke handicap </li > <li><i>CFR</i>-Bijlage rond geplande
gezinshereniging </li > <li><i>CPA</i>-Bijlage rond zwangerschaps- of
adoptieprocedure </li > <li><i>INCA</i>-Bijlage rond vrijgestelde
beroepsinkomsten uit het buitenland </li > <li><i>INCE</i>-Bijlage rond
vrijgestelde beroepsinkomsten verworven bij Europese of internationale
instellingen </li > <li><i>INCPS</i>-Tot 3 bijlages voor opeenvolgende
loonstroken van de afgelopen 6 maanden </li > <li><i>INCYB</i>-Bijlage
rond collectieve schuldenregeling, budgetbegeleiding of budgetbeheer
</li > <li><i>INCYM</i>-Bijlage rond onderhoudskosten </li >
<li><i>INCNB</i>-Bijlage rond collectieve schuldenregeling,
budgetbegeleiding of budgetbeheer </li > <li><i>INCNM</i>-Bijlage rond
onderhoudskosten </li > <li><i>PRF</i>-Bijlage rond lichamelijke
beperking </li > <li><i>OWN</i>-Bijlage over eigendomsbestanden </li >
<li><i>REJUU</i>-Bijlage over additionele eigendommen </li >
<li><i>REJUS</i>-Bijlage over bestaande eigendommen </li >
<li><i>HONE</i>-Bijlage over woonsituatie </li > <li><i>CRCV</i>-Bijlage
voor mantelzorg ontvanger </li > <li><i>CGIV</i>-Bijlage voor mantelzorg
gever </li > <li><i>PROXY</i>-Bijlage voor volmacht </li > </ul>
nullable: true
AanvaardingBijlageCodeWaarden:
enum:
- ACC
- REJ
- INC
type: string
description: >-
<p>Members:</p><ul><li><i>ACC</i>-Goedgekeurd </li >
<li><i>REJ</i>-Afgekeurd </li > <li><i>INC</i>-Extra informatie nodig
</li > </ul>
nullable: true
DossierPartijTypeCodeWaarden:
enum:
- PP
- SVK
- CPA
- TWN
- AMC
- VMSW
- SHM
- VWF
- PROV
- INMC
type: string
description: >-
<p>Members:</p><ul><li><i>PP</i>-Private Persoon </li >
<li><i>SVK</i>-SVK </li > <li><i>CPA</i>-OCMW </li >
<li><i>TWN</i>-Gemeente </li > <li><i>AMC</i>-Autonoom Gemeentebedrijf
</li > <li><i>VMSW</i>-VMSW </li > <li><i>SHM</i>-SHM </li >
<li><i>VWF</i>-VWF </li > <li><i>PROV</i>-Provincie </li >
<li><i>INMC</i>-Intercommunale </li > </ul>
nullable: true
DossierPartijRolCodeWaarden:
enum:
- REQ1
- REQ2
- CO
- SUP
- S
- P
type: string
description: >-
<p>Members:</p><ul><li><i>REQ1</i>-Referentiehuurder1 </li >
<li><i>REQ2</i>-Referentiehuurder2 </li > <li><i>CO</i>-Medebewoner </li
> <li><i>SUP</i>-Ondersteunende parij (OCMW…) </li >
<li><i>S</i>-Secundaire woonmaatschappij </li > <li><i>P</i>-Primaire
woonmaatschappij </li > </ul>
nullable: true
AanvaardingDossierTypeCode:
enum:
- PCOMP
- WPREF
- INCOM
- PROP
- PLR2
- PLR3
- PLR4
type: string
description: >-
<p>Members:</p><ul><li><i>PCOMP</i>-PersoonSamenstelling </li >
<li><i>WPREF</i>-Woningvoorkeuren </li > <li><i>INCOM</i>-Inkomsten </li
> <li><i>PROP</i>-Eigendom </li > <li><i>PLR2</i>-Woonnoodpijler2 </li >
<li><i>PLR3</i>-Woonnoodpijler3 </li > <li><i>PLR4</i>-Woonnoodpijler4
</li > </ul>
nullable: true
AanvaardingDossierCode:
enum:
- ACC
- NCOM
- FURI
type: string
description: >-
<p>Members:</p><ul><li><i>ACC</i>-Uitzondering toegekend </li >
<li><i>NCOM</i>-Uitzondering niet toegekend </li > <li><i>FURI</i>-Extra
informatie nodig </li > </ul>
nullable: true
ZwarteLijstRedenCodeWaarden:
enum:
- DEF
- HMNGL
type: string
description: >-
nvarchar(5)<p>Members:</p><ul><li><i>DEF</i>-Wanbetaling </li >
<li><i>HMNGL</i>-Huisverwaarlozing </li > </ul>
nullable: true
DossierDienstDossierPandUpdate:
type: object
properties:
postCode:
maxLength: 15
type: string
description: Postcode van het aangeboden pand
nullable: true
example: '2830'
gemeente:
maxLength: 100
type: string
description: Naam van de gemeente van het aangeboden pand
nullable: true
example: Willebroek
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode
nullable: true
example: 41002A
straat:
maxLength: 100
type: string
description: Straat van het aangeboden pand
nullable: true
example: Bos
huisNummer:
maxLength: 12
type: string
description: Huisnummer van het aangeboden pand
nullable: true
example: '502'
huisNummerBus:
maxLength: 10
type: string
description: Bus nr van het aangeboden pand
nullable: true
example: X
landNisCode:
maxLength: 5
type: string
description: Land code van het aangeboden pand
nullable: true
additionalProperties: false
nullable: true
DossierPandAanbiedingStatusCodeWaarden:
enum:
- OFFER
- CCL
- OBJCT
- REQI
- REF
- RJCT
- WAIT
- WAKE
- VOL
- ACC
- APP
- ARCH
- FRAUD
- DEC
- NCOMP
- NORES
- OVRVW
- REG
- RSPND
- SAVE
- UNDO
- ACTUA
- MIGRA
- NOACT
- CCLGW
- NOCOMP
- CONF
- UNDNR
- UNDRF
- OND
type: string
description: >-
nvarchar(5)<p>Members:</p><ul><li><i>OFFER</i>-Aanbod Maken </li >
<li><i>CCL</i>-Annuleren </li > <li><i>OBJCT</i>-Annuleren </li >
<li><i>REQI</i>-Bijkomende informatie vragen </li >
<li><i>REF</i>-Weigeren </li > <li><i>RJCT</i>-Afwijzen </li >
<li><i>WAIT</i>-In wacht zetten </li > <li><i>WAKE</i>-Uit wacht halen
</li > <li><i>VOL</i>-vrijwillig vertrekken </li > <li><i>ACC</i>-Aanbod
geaccepteerd </li > <li><i>APP</i>-Van toepassing zijn </li >
<li><i>ARCH</i>-Archief </li > <li><i>FRAUD</i>-frauduleus </li >
<li><i>DEC</i>-Overleden </li > <li><i>NCOMP</i>-Niet-conform </li >
<li><i>NORES</i>-Geen antwoord </li > <li><i>OVRVW</i>-Overzicht </li >
<li><i>REG</i>-Register </li > <li><i>RSPND</i>-Antwoorden </li >
<li><i>SAVE</i>-Opslaan </li > <li><i>UNDO</i>-Ga terug naar de vorige
echte staat </li > <li><i>ACTUA</i>-Actualisatie </li >
<li><i>MIGRA</i>-Via de actualisatie zijn wijzigingen aangebracht </li >
<li><i>NOACT</i>-Actie na 2 jaar inactiviteit </li >
<li><i>CCLGW</i>-Gegronde weigering door kandidaat-huurder na aanbod
</li > <li><i>NOCOMP</i>-Schrapping door niet voldoen
inschrijvingsvoorwaarde </li > <li><i>CONF</i>-Bevestigen van dossier na
migratie </li > <li><i>UNDNR</i>-Ongedaan maken van vroegere niet
reactie </li > <li><i>UNDRF</i>-Ongedaan maken van vroegere weigering
</li > <li><i>OND</i>-Schrapping door ontdubbeling </li > </ul>
nullable: true
DossierDienstDossierIncomeAuthentiekebron:
type: object
properties:
inkomenType:
$ref: '#/components/schemas/HuidigInkomenType'
jaarMaand:
maxLength: 15
type: string
description: Jaar maand van het inkomen
nullable: true
bedrag:
maxLength: 15
type: number
description: Bedrag inkomen
format: double
nullable: true
additionalProperties: false
nullable: true
SchuldenregelingCodeWaarden:
enum:
- 'YES'
- 'NO'
- UNK
type: string
description: >-
<p>Members:</p><ul><li><i>YES</i>-YES </li > <li><i>NO</i>-NO </li >
<li><i>UNK</i>-UNK </li > </ul>
nullable: true
OnderhoudsgeldenCodeWaarden:
enum:
- 'YES'
- 'NO'
- UNK
type: string
description: >-
<p>Members:</p><ul><li><i>YES</i>-YES </li > <li><i>NO</i>-NO </li >
<li><i>UNK</i>-UNK </li > </ul>
nullable: true
WoningTypeCodeWaarden:
enum:
- H
- R
- A
- S
type: string
description: >-
Woning Type (PRES)<p>Members:</p><ul><li><i>H</i>-Huis </li >
<li><i>R</i>-Kamer </li > <li><i>A</i>-Appartement </li >
<li><i>S</i>-Studio </li > </ul>
nullable: true
LichamelijkeBeperkingCodeWaarden:
enum:
- 'NO'
- 'YES'
type: string
description: >-
Of de KH een aangepaste woning wenst aan medische
noden<p>Members:</p><ul><li><i>NO</i>-Geen aanpassing voor lichamelijke
beperking nodig </li > <li><i>YES</i>-Aanpassing voor lichamelijke
beperking nodig </li > </ul>
nullable: true
InschrijfhulpCodeWaarden:
enum:
- HC
- OCMW
- OTH
- SUP
- WH
- HOEH
type: string
description: >-
Inschrijfhulp Code (RAOP)<p>Members:</p><ul><li><i>HC</i>-Samen met een
medewerker van de woonmaatschapij </li > <li><i>OCMW</i>-Samen met een
medewerker van een sociaalHuis </li > <li><i>OTH</i>-Samen met andere
persoon </li > <li><i>SUP</i>-Samen met begeleider </li >
<li><i>WH</i>-Zonder Hulp </li > <li><i>HOEH</i>-Gemeentelijk
woonloket/gemeentelijk woon- en energieloket </li > </ul>
nullable: true
InschrijfhulpInformerenCodeWaarden:
enum:
- 'NO'
- 'YES'
type: string
description: >-
Inschrijfhulp Informeren Code
(PKIS)<p>Members:</p><ul><li><i>NO</i>-Niet Informeren </li >
<li><i>YES</i>-Informeren </li > </ul>
nullable: true
SchrappingRedenCodeWaarden:
enum:
- DEAD
- SNRE
- SUNR
- ASGN
- OWNR
- NCOM
- FRAUD
- JOAN
- NACT
type: string
description: >-
Schrapping Redenen (RCNC)<p>Members:</p><ul><li><i>DEAD</i>-Overlijden
</li > <li><i>SNRE</i>-Tweede niet reactie </li > <li><i>SUNR</i>-Tweede
ongegronde weigering </li > <li><i>ASGN</i>-Toewijzing </li >
<li><i>OWNR</i>-Eigen vraag </li > <li><i>NCOM</i>-Niet voldoen aan
voorwaarden </li > <li><i>FRAUD</i>-Frauduleuze verklaringen </li >
<li><i>JOAN</i>-Gerechterlijk bevel na overlast </li >
<li><i>NACT</i>-Non-activiteit </li > </ul>
nullable: true
WoningnoodRedenEnumCode:
enum:
- EHOME
- UASIL
- MHP
- SUBSH
- SPSC
type: string
description: >-
<p>Members:</p><ul><li><i>EHOME</i>-Personen die dak- en thuisloos zijn
of dreigen te worden </li > <li><i>UASIL</i>-Jongeren die zelfstandig
wonen of gaan wonen met begeleiding door een erkende dienst </li >
<li><i>MHP</i>-Personen met geestelijke gezondheidsproblemen </li >
<li><i>SUBSH</i>-Personen die in slechte huisvesting wonen </li >
<li><i>SPSC</i>-Personen die zich in bijzondere omstandigheden van
sociale aard bevinden </li > </ul>
nullable: true
BelastbaarInkomenAanwezigheidCodeWaarden:
enum:
- TBV
- SND
- S6
- FT
- UV
type: string
description: >-
Dit veld geeft aan of er inkomen (FOD Financiën) gevonden werden bij de
authentieke bron en/of ze opgenomen worden in het
CIR.<p>Members:</p><ul><li><i>TBV</i>-Te verifiëren </li >
<li><i>SND</i>-Succesvol geverifieerd zonder gegevens </li >
<li><i>S6</i>-Succesvol geverifieerd </li > <li><i>FT</i>-Verificatie
mislukt om technische reden </li > <li><i>UV</i>-Niet verifieerbaar of
verificatie mislukt </li > </ul>
nullable: true
LeefLoonAanwezigheidCodeWaarden:
enum:
- TBV
- SND
- S6
- FT
- UV
type: string
description: >-
Dit veld geeft aan of er leefloongegevens gevonden werden bij de
authentieke bron en/of ze opgenomen worden in het
CIR.<p>Members:</p><ul><li><i>TBV</i>-Te verifiëren </li >
<li><i>SND</i>-Succesvol geverifieerd zonder gegevens </li >
<li><i>S6</i>-Succesvol geverifieerd </li > <li><i>FT</i>-Verificatie
mislukt om technische reden </li > <li><i>UV</i>-Niet verifieerbaar of
verificatie mislukt </li > </ul>
nullable: true
InkomensVervangendeTegemoetkomingCodeWaarden:
enum:
- TBV
- SND
- S6
- FT
- UV
type: string
description: >-
Dit veld geeft aan of er inkomen vervangende-gegevens gevonden werden
bij de authentieke bron en/of ze opgenomen worden in het
CIR.<p>Members:</p><ul><li><i>TBV</i>-Te verifiëren </li >
<li><i>SND</i>-Succesvol geverifieerd zonder gegevens </li >
<li><i>S6</i>-Succesvol geverifieerd </li > <li><i>FT</i>-Verificatie
mislukt om technische reden </li > <li><i>UV</i>-Niet verifieerbaar of
verificatie mislukt </li > </ul>
nullable: true
ContactVoorkeurCodeWaarden:
enum:
- ALT
- DOM
- OTH
type: string
description: >-
Wat als contactadres gerbuikt mag
worden<p>Members:</p><ul><li><i>ALT</i>-Verblijfs Adress </li >
<li><i>DOM</i>-Domicilie Adress </li > <li><i>OTH</i>-Contact Adress
</li > </ul>
nullable: true
DossierDienstDossierPersoonAdresDomicilie:
type: object
properties:
postCode:
maxLength: 15
type: string
description: Postcode van de domicilie van het contact/gezinslid
nullable: true
example: '2830'
gemeente:
maxLength: 100
type: string
description: Naam van de gemeente waar domicilie gevestigd is.
nullable: true
example: Willebroek
gemeenteNisCode:
maxLength: 15
type: string
description: Gemeenteniscode van het domicilie adress
nullable: true
landCode:
maxLength: 5
type: string
description: landcode van de domicilie.
nullable: true
straat:
maxLength: 100
type: string
description: Naam van de straat waar domicilie gevestigd is.
nullable: true
example: Bos
huisNummer:
maxLength: 12
type: string
description: Huisnummer waar domicilie gevestigd is.
nullable: true
example: '502'
huisNummerBus:
maxLength: 10
type: string
description: Bus van de domicilie.
nullable: true
example: X
additionalProperties: false
nullable: true
DossierDienstDossierPersoonAdresVerblijf:
type: object
properties:
postCode:
maxLength: 15
type: string
description: Postcode waar het contact/gezinslid verblijft.
nullable: true
example: '2830'
gemeente:
maxLength: 100
type: string
description: Gemeente waar het contact/gezinslid verblijft
nullable: true
example: Willebroek
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode van verblijf aanvrager
nullable: true
landCode:
maxLength: 5
type: string
description: Niscode van verblijf aanvrager
nullable: true
straat:
maxLength: 100
type: string
description: Straat van verblijf van aanvrager
nullable: true
example: Bos
huisNummer:
maxLength: 12
type: string
description: Huisnummer van verblijf aanvrager
nullable: true
example: '502'
huisNummerBus:
maxLength: 10
type: string
description: Bus van verbflijf van het contact/gezinslid
nullable: true
example: X
additionalProperties: false
nullable: true
DossierDienstDossierPersoonAdresContact:
type: object
properties:
postCode:
maxLength: 15
type: string
description: De postcode van het postadres van het contact/gezinslid.
nullable: true
example: '2830'
gemeente:
maxLength: 100
type: string
description: De gemeente van het postadres van het contact/gezinslid.
nullable: true
example: Willebroek
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode van het postadres van het contact/gezinslid
nullable: true
landCode:
maxLength: 5
type: string
description: De landcode van het postadres van het contact/gezinslid.
nullable: true
straat:
maxLength: 100
type: string
description: De straat van het postadres van het contact/gezinslid.
nullable: true
example: Bos
huisNummer:
maxLength: 12
type: string
description: Het huisnummer van het postadres van het contact/gezinslid.
nullable: true
example: '502'
huisNummerBus:
maxLength: 10
type: string
description: De busnummer van het postadres van het contact/gezinslid.
nullable: true
example: X
additionalProperties: false
nullable: true
HuidigInkomenType:
enum:
- PENS
- LINC
- IVT
- UNEMP
- INCAP
type: string
description: >-
<p>Members:</p><ul><li><i>PENS</i>-Pensioen6m </li >
<li><i>LINC</i>-Leefloon6m </li > <li><i>IVT</i>-IVT6m </li >
<li><i>UNEMP</i>-Werkloosheidsuitkering6m </li >
<li><i>INCAP</i>-Uitkeringarbeidsongeschikdheid6m </li > </ul>
nullable: true
DossierDienstDossierWijziging:
type: object
properties:
dossierPersonen:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierPersoonWijziging'
description: Contacten
nullable: true
dossierBijlages:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierUpdateBijlage'
nullable: true
aanvaardingDossier:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierAanvaarding'
nullable: true
extraBeroepsInkomsten:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierUpdateExtraBeroepsInkomsten'
nullable: true
aanvaardingWoonnood:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierUpdateAanvaardingWoonnood'
nullable: true
additionalProperties: false
description: Description
nullable: true
DossierDienstDossierPersoonWijziging:
type: object
properties:
rijksregisternummer:
maxLength: 15
type: string
description: RRN
nullable: true
example: '2209280001'
contactPersoonTenLaste:
$ref: '#/components/schemas/RegistratieContactPersoonTenLaste'
taalkennisSneltestCode:
$ref: '#/components/schemas/TaalkennisSneltestCodeWaarden'
additionalProperties: false
nullable: true
DossierDienstDossierUpdateBijlage:
type: object
properties:
identificatie:
maxLength: 255
type: string
description: Identificatie van de bijlage
nullable: true
aanvaardingBijlageCode:
$ref: '#/components/schemas/AanvaardingBijlageCodeWaarden'
aanvaardingOpmerking:
type: string
description: Geeft de opmerking bij de bijlage
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierAanvaarding:
type: object
properties:
typeCode:
$ref: '#/components/schemas/TypeCodeWaarden'
aanvaardingCode:
$ref: '#/components/schemas/AanvaardingCodeWaarden'
opmerking:
type: string
description: Opmerking bij de beslissing.
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierUpdateAanvaardingWoonnood:
type: object
properties:
identificatie:
type: integer
description: ID van de woonsituatie die goedgekeurd moet worden
format: int64
nullable: true
aanvaardingCode:
$ref: '#/components/schemas/AanvaardingDossierCode'
conclusie:
type: string
description: Conclusie bij de woonnood
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierUpdateExtraBeroepsInkomsten:
type: object
properties:
inkomstenType:
$ref: '#/components/schemas/ExtraBeroepsInkomstenCodeWaarden'
jaarTotaal:
type: number
description: Geeft het jaar waarin het inkomen werd ontvangen
format: double
nullable: true
example: 2022
rijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer
nullable: true
example: '2209280001'
additionalProperties: false
nullable: true
TypeCodeWaarden:
enum:
- PCOMP
- WPREF
- INCOM
- PROP
- PLR2
- PLR3
- PLR4
type: string
description: >-
<p>Members:</p><ul><li><i>PCOMP</i>-PersoonSamenstelling </li >
<li><i>WPREF</i>-Woningvoorkeuren </li > <li><i>INCOM</i>-Inkomsten </li
> <li><i>PROP</i>-Eigendom </li > <li><i>PLR2</i>-Woonnoodpijler2 </li >
<li><i>PLR3</i>-Woonnoodpijler3 </li > <li><i>PLR4</i>-Woonnoodpijler4
</li > </ul>
nullable: true
AanvaardingCodeWaarden:
enum:
- ACC
- NCOM
- FURI
type: string
description: >-
<p>Members:</p><ul><li><i>ACC</i>-Uitzondering toegekend </li >
<li><i>NCOM</i>-Uitzondering niet toegekend </li > <li><i>FURI</i>-Extra
informatie nodig </li > </ul>
nullable: true
ExtraBeroepsInkomstenCodeWaarden:
enum:
- FORI
- INSTI
type: string
description: >-
<p>Members:</p><ul><li><i>FORI</i>-Inkomsten uit het buitenland </li >
<li><i>INSTI</i>-Inkomsten uit europese of internationale instellingen
</li > </ul>
nullable: true
DossierDienstDossierVersieBevestiging:
type: object
properties:
dossierNummer:
type: string
description: nvarchar(15)
nullable: true
example: YYY.MM.DD.XXXX
partijCode:
type: string
description: "KBO nummer of CIR code van de partij die betrokken is bij het dossier.\r\n nvarchar(15)"
nullable: true
versieNummer:
type: integer
description: Int
format: int32
additionalProperties: false
nullable: true
DossierDienstDossierRanglijstWijzigingen:
type: object
properties:
partijCode:
maxLength: 15
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
ranglijstWijzigingen:
type: array
items:
$ref: '#/components/schemas/DossierDienstDossierRanglijstWijziging'
description: >-
RanglijstWijzigingen kunnen doorgestuurd worden voor meerdere
gemeentes voor meerdere dossiers
nullable: true
additionalProperties: false
description: >-
RanglijstWijzigingen kunnen doorgestuurd worden voor meerdere gemeentes
voor meerdere dossiers
nullable: true
DossierDienstDossierRanglijstWijziging:
type: object
properties:
rangLijstType:
$ref: '#/components/schemas/RangLijstTypeCodeWaarden'
dossierNummer:
maxLength: 15
type: string
description: ''
nullable: true
example: 2022.09.08.0001
beperkteRegioKeuze:
$ref: '#/components/schemas/beperkteregiokeuze'
lokaleBinding:
$ref: '#/components/schemas/localebinding'
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode van de gemeente waar de kandidaat-huurder wil wonen.
nullable: true
example: '12100'
wijk:
type: string
description: >-
Geeft de wijk van de gemeente/deelgemeenten weer, waar de
Kandidaat-huurder wil wonen.
nullable: true
criterium1:
$ref: '#/components/schemas/RangLijstCriteria1CodeWaarden'
criterium2:
maxLength: 500
type: string
nullable: true
criterium3:
maxLength: 500
type: string
nullable: true
rangschikking:
type: integer
description: >-
Geeft weer op welke plaats de kandidaat-huurder op de wachtlijst
staat.
format: int32
nullable: true
example: 17
rangschikkingDatum:
type: string
description: >-
Geeft de datum weer wanneer de kandidaat-huurder op de wachtlijst
geplaatst werd.
format: date-time
nullable: true
additionalProperties: false
nullable: true
RangLijstTypeCodeWaarden:
enum:
- PLR1
- PLR2
- PLR3
- PLR4
type: string
description: >-
Rang Lijst Type Code (RRTP)<p>Members:</p><ul><li><i>PLR1</i>-Pijler 1
</li > <li><i>PLR2</i>-Pijler 2 </li > <li><i>PLR3</i>-Pijler 3 </li >
<li><i>PLR4</i>-Pijler 4 </li > </ul>
nullable: true
beperkteregiokeuze:
enum:
- 'YES'
- 'NO'
- UNK
type: string
description: >-
<p>Members:</p><ul><li><i>YES</i>-Wel beperkte regiokeuze </li >
<li><i>NO</i>-Geen beperkte regiokeuze </li > <li><i>UNK</i>-Niet gekend
</li > </ul>
nullable: true
localebinding:
enum:
- 'YES'
- 'NO'
- UNK
type: string
description: >-
<p>Members:</p><ul><li><i>YES</i>-Wel locale binding </li >
<li><i>NO</i>-Geen locale binding </li > <li><i>UNK</i>-Niet gekend </li
> </ul>
nullable: true
RangLijstCriteria1CodeWaarden:
enum:
- H
- R
- A
- S
- EHOME
- UASIL
- MHP
- SUBSH
- SPSC
- D
- DERES
- UOCCU
- OCRWD
- NCRAT
- PRFR
- NOADA
- TOEZ
- REHOU
type: string
description: >-
nvarchar(15)<p>Members:</p><ul><li><i>H</i>-Huis (Pijler 1) </li >
<li><i>R</i>-Kamer (Pijler 1) </li > <li><i>A</i>-Appartement (Pijler 1)
</li > <li><i>S</i>-Studio (Pijler 1) </li > <li><i>EHOME</i>-Personen
die dak- en thuisloos zijn of dreigen te worden (Pijler 2) </li >
<li><i>UASIL</i>-Jongeren die zelfstandig wonen of gaan wonen met
begeleiding door een erkende dienst (Pijler 2) </li >
<li><i>MHP</i>-Personen met geestelijke gezondheidsproblemen (Pijler 2)
</li > <li><i>SUBSH</i>-Personen die in slechte huisvesting wonen
(Pijler 2) </li > <li><i>SPSC</i>-Personen die zich in bijzondere
omstandigheden van sociale aard bevinden (Pijler 2) </li >
<li><i>D</i>-Specifieke Doelgroep (Pijler 3) </li >
<li><i>DERES</i>-Sloop, renovatie en verkoop van de sociale huurwoning
(Pijler 4) </li > <li><i>UOCCU</i>-Onderbezetting van de sociale
huurwoning (Pijler 4) </li > <li><i>OCRWD</i>-Overbezetting van de
sociale huurwoning (Pijler 4) </li > <li><i>NCRAT</i>-Niet meer voldoen
aan de rationele bezetting (Pijler 4) </li > <li><i>PRFR</i>-Vooraf
vermelde gezinshereniging die plaatsvindt (Pijler 4) </li >
<li><i>NOADA</i>-Het niet meer nodig hebben van een aangepaste woning
(Pijler 4) </li > <li><i>TOEZ</i>-Het gegrond vinden van het verhaal bij
de toezichthouder (Pijler 4) </li > <li><i>REHOU</i>-Het herhuisvesten
bij de beëindiging van het hoofdhuurcontract van een ingehuurde woning
(Pijler 4) </li > </ul>
nullable: true
ZwarteLijstMeldingen:
type: object
properties:
partijCode:
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
meldingen:
type: array
items:
$ref: '#/components/schemas/ZwarteLijstMelding'
description: ZwarteLijstMeldingen kunnen doorgestuurd worden voor partijen
nullable: true
additionalProperties: false
nullable: true
ZwarteLijstMelding:
type: object
properties:
rijksregisternummer:
maxLength: 15
type: string
description: RRN van persoon op zwartelijst
nullable: true
reden:
$ref: '#/components/schemas/ZwarteLijstRedenCodeWaarden'
startDatum:
type: string
description: Datum vanaf wanneer persoon op zwartelijst staat
format: date-time
additionalProperties: false
nullable: true
PartijInformatieWijzigingen:
type: object
properties:
partijCode:
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
wijzingingen:
type: array
items:
$ref: '#/components/schemas/PartijInformatieWijziging'
nullable: true
additionalProperties: false
nullable: true
PartijInformatieWijziging:
type: object
properties:
rijksregisternummer:
maxLength: 15
type: string
description: Rijksregisternummer
nullable: true
example: '2209280001'
voorNaam:
maxLength: 48
type: string
description: Voornaam van bewindvoerder
nullable: true
example: Marc
naam:
maxLength: 128
type: string
description: Achternaam van bewindvoerder
nullable: true
example: Molenbergs
email:
maxLength: 50
type: string
description: E-mailadres van bewindvoerder
nullable: true
example: Marc.Molenbergs@hotmail.be
telefoon1:
maxLength: 15
type: string
description: Telefoonnummer van bewindvoerder
nullable: true
example: 015/43 43 43
telefoon2:
maxLength: 15
type: string
description: Telefoonnummer van bewindvoerder
nullable: true
example: 0477 / 43 43 43
adres:
$ref: '#/components/schemas/PartijAdres'
registratieTijdstip:
type: string
format: date-time
nullable: true
additionalProperties: false
nullable: true
PartijAdres:
type: object
properties:
postCode:
maxLength: 15
type: string
description: Postcode van de domicilie van bewindvoerder
nullable: true
example: '2830'
gemeente:
maxLength: 100
type: string
description: Naam van de gemeente van bewindvoerder
nullable: true
example: Willebroek
gemeenteNisCode:
maxLength: 15
type: string
description: Niscode
nullable: true
example: 41002A
landCode:
maxLength: 5
type: string
nullable: true
straat:
maxLength: 225
type: string
description: Straat van bewindvoerder
nullable: true
example: Bos
huisNummer:
maxLength: 50
type: string
description: Huisnummer van bewindvoerder
nullable: true
example: '502'
huisNummerBus:
maxLength: 50
type: string
description: Bus nr van bewindvoerder
nullable: true
example: X
additionalProperties: false
nullable: true
GetZwarteLijstMeldingVerzoek:
type: object
properties:
rijksregisternummer:
type: string
nullable: true
example: '12345678901'
additionalProperties: false
nullable: true
GetZwarteLijstMelding:
type: object
properties:
opZwarteLijst:
type: boolean
description: Aanduiding of de persoon op de zwartelijst staat of niet.
partijCode:
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
reden:
$ref: '#/components/schemas/ZwarteLijstRedenCodeWaarden'
startDatum:
type: string
description: Datum vanaf wanneer persoon op zwartelijst moet
format: date-time
nullable: true
additionalProperties: false
nullable: true
DossierDienstDossierActie:
type: object
properties:
dossierNummer:
type: string
description: nvarchar(15)
nullable: true
example: YYY.MM.DD.XXXX
partijCode:
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
nullable: true
example: '1234'
actie:
$ref: '#/components/schemas/DossierActieCodeWaarden'
commentaar:
type: string
description: Commentaar bij de actie
nullable: true
datumIngangContract:
type: string
description: Datum van ingang contract huurder
format: date-time
nullable: true
pand:
$ref: '#/components/schemas/DossierDienstDossierPandUpdate'
additionalProperties: false
nullable: true
GemeenteDienstZoekResultaats:
type: object
properties:
gemeentes:
type: array
items:
$ref: '#/components/schemas/GemeenteDienstZoekResultaat'
nullable: true
additionalProperties: false
nullable: true
GemeenteDienstZoekResultaat:
type: object
properties:
nisCode:
type: string
nullable: true
naam:
type: string
nullable: true
taal:
type: string
nullable: true
regioCode:
type: string
nullable: true
provincieCode:
type: string
nullable: true
districtCode:
type: string
nullable: true
lengteGraad:
type: number
format: double
nullable: true
breedteGraad:
type: number
format: double
nullable: true
deelgemeentes:
type: array
items:
$ref: '#/components/schemas/GemeenteDienstZoekResultaatDeelgemeente'
nullable: true
additionalProperties: false
nullable: true
GemeenteDienstZoekResultaatDeelgemeente:
type: object
properties:
nisCode:
type: string
nullable: true
zip:
type: string
nullable: true
naam:
type: string
nullable: true
additionalProperties: false
nullable: true
GemeenteDienstWijken:
type: object
properties:
wijken:
type: array
items:
$ref: '#/components/schemas/GemeenteDienstWijk'
nullable: true
additionalProperties: false
nullable: true
GemeenteDienstWijk:
type: object
properties:
wijkNaam:
type: string
nullable: true
gemeenteNisCode:
type: string
nullable: true
additionalProperties: false
nullable: true
DossierDienstBijlageCriteria:
required:
- bijlageIdentificatie
- dossierNummer
- partijCode
type: object
properties:
partijCode:
maxLength: 15
type: string
description: >-
KBO nummer of CIR code van de partij die betrokken is bij het
dossier.
example: '5025'
dossierNummer:
maxLength: 15
type: string
description: DossierNummer nvarchar(15)
example: YYYY.MM.DD.XXXX
bijlageIdentificatie:
type: string
description: Identificatie van de bijlage
example: CCTS-0-12345678900
additionalProperties: false
nullable: true
DossierDienstDossierWoonsituatie:
type: object
properties:
omschrijving:
type: string
description: Woonsituatie reden omschrijving
nullable: true
identificatie:
type: string
description: Identificatie van de Woonsituatie
nullable: true
additionalProperties: false
description: Woonsituatie voor het dossier
nullable: true
#----------------------- END CIR payloads -------------------------------
#----------------------- START CWR WoningenAPI -------------------------------
WoningV2Response:
type: object
properties:
'@context':
type: string
nullable: true
'@id':
type: string
format: uri
example: /v2/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}
nullable: true
'@magdaId':
type: string
format: uri
nullable: true
'@type':
type: string
default: WivWoningResource
nullable: true
value:
$ref: '#/components/schemas/WivWoningResource'
additionalProperties: false
WivWoningResource:
type: object
properties:
eigenaar:
$ref: '#/components/schemas/OrganisatieResourceMetOsloType'
beheerder:
$ref: '#/components/schemas/OrganisatieResourceMetOsloType'
verhuringsStelsel:
enum:
- Sociale verhuur gesubsidieerd
- Geconventioneerde verhuur
- Sociale verhuur
type: string
woonmaatschappijWoningId:
type: string
description: Het Id van de woning in de applicatie van de woonmaatschappij
nullable: true
example: O02034#22
woonmaatschappijWoningCode:
type: string
description: De code voor de woning in de applicatie van de woonmaatschappij
nullable: true
example: 29 06 00 00 00 27
woonmaatschappijWoningGroepCode:
type: string
description: De code van de groep waartoe de woning behoort
nullable: true
example: ZJV-JVB-V
bouwjaar:
type: integer
format: int32
nullable: true
vmswWoningId:
type: string
nullable: true
gebouweenheidIds:
type: array
items:
type: string
nullable: true
adres:
$ref: '#/components/schemas/VmswAdres'
statistischeSector:
type: string
nullable: true
wijk:
type: string
nullable: true
woningType:
enum:
- Woning
- Appartement
type: string
nullable: true
woningStatus:
enum:
- In beheer
- Uit beheer
type: string
bebouwingsType:
enum:
- Gesloten bebouwing
- Halfopen bebouwing
- Open bebouwing
- Appartement vloer
- Appartement hoek vloer
- Appartement midden
- Appartement zij
- Appartement dak
- Appartement hoek dak
type: string
nullable: true
additionalProperties: false
VmswAdres:
type: object
properties:
straatnaam:
$ref: '#/components/schemas/TaalString'
huisnummer:
type: string
nullable: true
busnummer:
type: string
nullable: true
postcode:
type: string
nullable: true
gemeentenaam:
$ref: '#/components/schemas/TaalString'
gemeenteNISCode:
type: string
nullable: true
additionalProperties: false
TaalString:
type: object
properties:
'@type':
type: string
default: http://www.w3.org/1999/02/22-rdf-syntax-ns#langString
nullable: true
spelling:
type: string
nullable: true
taal:
type: string
default: nl-BE
nullable: true
additionalProperties: false
OrganisatieResourceMetOsloType:
type: object
properties:
'@type':
type: string
default: OrganisatieResource
nullable: true
organisatieType:
enum:
- Woonmaatschappij
- OCMW
- Gemeente
- Private initiatiefnemer
type: string
organisatieId:
pattern: ^[01]\d{9}$
type: string
nullable: true
additionalProperties: false
V2WoningWijzigen:
type: object
properties:
status:
enum:
- In beheer
- Uit beheer
type: string
nullable: true
eigenaarOrganisatieId:
type: string
nullable: true
gebouweenheidId:
type: string
nullable: true
example: '16480205'
woonmaatschappijWoningId:
type: string
description: Het Id van de woning in de applicatie van de woonmaatschappij
nullable: true
example: O02034#22
woonmaatschappijWoningCode:
type: string
description: De code voor de woning in de applicatie van de woonmaatschappij
nullable: true
example: 29 06 00 00 00 27
woonmaatschappijWoningGroepCode:
type: string
description: De code van de groep waartoe de woning behoort
nullable: true
example: ZJV-JVB-V
adres:
$ref: '#/components/schemas/AdresZoeken'
bouwjaar:
type: integer
format: int32
nullable: true
bebouwingsType:
enum:
- Gesloten bebouwing
- Halfopen bebouwing
- Open bebouwing
- Appartement vloer
- Appartement hoek vloer
- Appartement midden
- Appartement zij
- Appartement dak
- Appartement hoek dak
type: string
nullable: true
additionalProperties: false
AdresZoeken:
type: object
properties:
straatnaam:
type: string
nullable: true
huisnummer:
type: string
nullable: true
busnummer:
type: string
nullable: true
postcode:
type: string
nullable: true
gemeenteNISCode:
type: string
nullable: true
additionalProperties: false
V2WoningToevoegen:
type: object
properties:
eigenaarOrganisatieId:
type: string
nullable: true
gebouweenheidId:
type: string
nullable: true
example: '16480205'
woonmaatschappijWoningId:
type: string
description: Het Id van de woning in de applicatie van de woonmaatschappij
nullable: true
example: O02034#22
woonmaatschappijWoningCode:
type: string
description: De code voor de woning in de applicatie van de woonmaatschappij
nullable: true
example: 29 06 00 00 00 27
woonmaatschappijWoningGroepCode:
type: string
description: De code van de groep waartoe de woning behoort
nullable: true
example: ZJV-JVB-V
adres:
$ref: '#/components/schemas/AdresZoeken'
bouwjaar:
type: integer
format: int32
nullable: true
bebouwingsType:
enum:
- Gesloten bebouwing
- Halfopen bebouwing
- Open bebouwing
- Appartement vloer
- Appartement hoek vloer
- Appartement midden
- Appartement zij
- Appartement dak
- Appartement hoek dak
type: string
nullable: true
additionalProperties: false
ProblemDetailsValidationErrorExtension:
type: object
properties:
validationErrors:
type: array
items:
$ref: '#/components/schemas/ValidationError'
nullable: true
readOnly: true
type:
type: string
default: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/{Status}
nullable: true
title:
type: string
nullable: true
status:
type: integer
format: int32
detail:
type: string
nullable: true
instance:
type: string
nullable: true
additionalProperties: false
ValidationError:
type: object
properties:
name:
type: string
nullable: true
readOnly: true
reason:
type: string
nullable: true
readOnly: true
additionalProperties: false
#----------------------- END CWR WoningenAPI payloads -------------------------------
#----------------------- START CWR Woningbezetting payloads -------------------------------
WoningBezetting:
type: object
title: WoningBezetting
properties:
'@id':
type: string
format: uri
example: 'https://cwr-host/id/woningbezetting/123'
'@type':
type: string
default: WoningBezetting
woningBezettingsType:
$ref: '#/components/schemas/WoningBezettingsType'
vmswWoningId:
type: string
datumBezettingVan:
type: string
format: date
datumBezettingTot:
type: string
format: date
description: 'Verplicht veld, maar kan leeg zijn'
leegstandsType:
$ref: '#/components/schemas/LeegstandsType'
verhuring:
$ref: '#/components/schemas/Verhuring'
huurstelsel:
type: string
description: |-
- BIS = Verhuring binnen het sociaal stelsel zoals vermeld in het kaderbesluit sociale huur
- BUS = Verhuring buiten het sociaal stelsel zoals vermeld in artikel 55bis tot en met artikel 55exies van het Kaderbesluit Sociale Huur
- GW = Goede woning zoals vermeld in hoofdstuk 3 van het ministerieel besluit van 19/12/2008
- COM = Verhuring als niet-residentieële ruimte (garages, winkels)
- BOV = Bezettingsovereenkomst gesloten met bijwoners wanneer de laatste huurder overlijdt
- Andere = Ander soort verhuring
- NVT = Niet van toepassing
enum:
- BIS
- BUS
- GW
- COM
- BOV
- Andere
- NVT
required:
- woningBezettingsType
- vmswWoningId
- datumBezettingTot
- huurstelsel
Verhuring:
type: object
title: ''
description: ''
properties:
'@type':
type: string
default: Verhuring
huurder:
$ref: '#/components/schemas/Agent'
huurprijsberekening:
type: array
items:
$ref: '#/components/schemas/Huurprijsberekening'
tijdelijkHuurContract:
type: boolean
begindatumHuurContract:
type: string
description: Verplicht bij tijdelijk contract
format: date
pattern: yyyy-mm-dd
einddatumHuurContract:
type: string
description: Verplicht bij tijdelijk contract
format: date
pattern: yyy-mm-dd
basisHuurprijs:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
referentieHuurprijs:
type: string
format: double
description: 'Is de referentiehuurprijs van de woning. Deze huurprijs geldt enkel tijdens de overgangsperiode. Gebruik als decimaal scheidingsteken een punt (“.”). Gebruik geen duizend-scheidingsteken, plusteken of enige andere opmaak. Dit veld is enkel verplicht voor woongelegenheden en dit zolang de overgangsregeling vermeld in het kaderbesluit sociale huur van toepassing is.'
pattern: '[0-9]+\.?[0-9]*'
patrimoniumkorting:
type: string
description: 'Dit veld is niet van toepassing tijdens de overgangsperiode. Is een decimaal getal. Gebruik als decimaal scheidingsteken een punt (“.”). Gebruik geen duizend-scheidingsteken, plusteken of enige andere opmaak. Dit veld is verplicht voor alle woongelegenheden verhuurd binnen het sociaal stelsel van zodra de patrimoniumkorting effectief ingevoerd wordt.'
pattern: '[0-9]+\.?[0-9]*'
energiecorrectie:
type: string
format: double
description: 'De totale energiecorrectie. Voorlopig kan dit nog niet ingevuld worden. Is een decimaal getal. Gebruik als decimaal scheidingsteken een punt (“.”). Gebruik geen duizend-scheidingsteken, plusteken of enige andere opmaak. Dit veld is verplicht voor alle woongelegenheden verhuurd binnen het sociaal stelsel van zodra de energiecorrectie effectief ingevoerd wordt.'
pattern: '[0-9]+\.?[0-9]*'
huurlasten:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
toegepasteBasisHuurprijs:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
gezinsleden:
type: array
items:
$ref: '#/components/schemas/Gezinslid'
huurOpzegging:
$ref: '#/components/schemas/HuurOpzegging'
required:
- tijdelijkHuurContract
LeegstandsType:
type: object
x-examples: {}
properties:
'@type':
type: string
default: LeegstandsType
structureel:
type: boolean
leegstandsTypeCode:
type: integer
description: |-
Indien niet-structureel => opties:
1 Overlijden van huurder
2 Woning die leegstaat in afwachting van verhuring aan de huurde die door renovatie zijn sociale woning gaat ontruimen
3 Frictieleegstand
required:
- structureel
Huurprijsberekening:
type: object
properties:
'@type':
type: string
default: Huurprijsberekening
beginDatumHuurprijsberekening:
type: string
format: date
pattern: yyyy-mm-dd
eindDatumHuurprijsberekening:
type: string
format: date
pattern: yyyy-mm-dd
personenTenLaste:
type: string
format: double
description: |-
Is het aantal personen ten laste voor de betreffende huurder zoals van toepassing in het kaderbesluit sociale huur. Is niet altijd hetzelfde als het aantal gezinsleden. Is een getal tussen 0 en 99 (grenzen inbegrepen).
Het cijfer kan ook **halve personen** ten laste bevatten. PTL is de som van Aantalkinderen en AantalHandicap. Dit veld is niet verplicht wanneer het winkels of garages betreft.
pattern: '[0-9]+\.?[0-9]*'
aantalKinderen:
type: integer
format: int32
aantalMetHandicap:
type: integer
format: int32
aantalGezinsleden:
type: integer
format: int32
totaalInkomen:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
totaalInkomenNietGeindexeerd:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
reeleHuur:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
gezinskorting:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
onderbezettingsvergoeding:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
required:
- beginDatumHuurprijsberekening
- eindDatumHuurprijsberekening
- reeleHuur
Gezinslid:
type: object
description: ''
title: Gezinslid
properties:
'@type':
type: string
default: Gezinslid
computerNummer:
type: string
description: |
Het nummer waarmee de huurder in de databank van de SHM wordt geïdentificeerd.
metHandicap:
type: boolean
gezinsRelatie:
$ref: '#/components/schemas/RelatieType'
persoon:
$ref: '#/components/schemas/GeregistreerdPersoon'
required:
- gezinsRelatie
Geboorte:
title: Geboorte
x-stoplight:
id: nzn6f8k9i10uq
type: object
properties:
'@type':
type: string
default: Geboorte
datum:
type: string
plaats:
$ref: '#/components/schemas/Plaats'
Agent:
title: Agent
x-stoplight:
id: r30hkva8og2gy
type: object
description: Dit is een persoon of organisatie aan wie de woning verhuurd wordt
properties:
'@type':
type: string
default: Agent
persoon:
$ref: '#/components/schemas/PersoonRegistratie'
organisatie:
$ref: '#/components/schemas/OrganisatieRegistratie'
HuurOpzegging:
title: HuurOpzegging
x-stoplight:
id: u407h8hjtuktk
type: object
properties:
'@type':
type: string
default: HuurOpzegging
UithuiszettingsReden:
type: array
items:
$ref: '#/components/schemas/TaalString'
UithuiszettingDetail:
type: array
items:
$ref: '#/components/schemas/TaalString'
UithuiszettingOpgestart:
type: boolean
UithuiszettingEffectief:
type: boolean
OntbindingsReden:
type: array
items:
$ref: '#/components/schemas/TaalString'
OntbindingsDetail:
type: array
items:
$ref: '#/components/schemas/TaalString'
Nationaliteit:
title: Nationaliteit
x-stoplight:
id: 2xul36lbmwsvc
type: object
properties:
'@type':
type: string
default: Nationaliteit
nationaliteitscode:
type: string
nationaliteit:
type: array
items:
$ref: '#/components/schemas/TaalString'
GeregistreerdPersoon:
title: GeregistreerdPersoon
x-stoplight:
id: yf0e42cfm26wc
type: object
properties:
'@type':
type: string
default: 'https://data.vlaanderen.be/ns/persoon#GeregistreerdPersoon'
registratie:
$ref: '#/components/schemas/Identificator'
voornaam:
type: array
items:
type: string
gebruikteVoornaam:
type: string
achternaam:
type: array
items:
type: string
volledigeNaam:
type: string
heeftGeboorte:
$ref: '#/components/schemas/Geboorte'
geslacht:
type: array
items:
$ref: '#/components/schemas/TaalString'
heeftNationaliteit:
type: array
items:
$ref: '#/components/schemas/Nationaliteit'
Identificator:
title: Identificator
x-stoplight:
id: bipk6o53h7iof
type: object
properties:
'@type':
type: string
default: Identificator
identificator:
type: string
description: |
Insznummer
Response:
title: Response
x-stoplight:
id: u18uoyp5urpwd
type: object
properties:
'@context':
type: string
items:
type: array
items:
$ref: '#/components/schemas/WoningBezetting'
RelatieType:
title: RelatieType
type: object
properties:
'@type':
type: string
default: RelatieType
spelling:
type: string
enum:
- Onbekend
- Gezinshoofd
- Echtgenoot of Echtgenote
- Zoon of Dochter
- Schoonzoon of Schoondochter
- Kleinzoon of Kleindochter
- Vader of Moeder
- Schoonvader of Schoonmoeder
- Grootvader of Grootmoeder
- Broer of Zuster
- Schoonbroer of Schoonzuster
- Verwant of Verwante
- Zonder familieband
- Stiefzoon of Stiefdochter
- Achterkleinzoon of Achterkleindochter
- Oom of Tante
- Neef of Nicht (verwantschap 3de graad)
- Neef of Nicht (verwantschap 4de graad)
- Gemeenschappen of Tehuizen
taal:
type: string
default: nl-BE
Plaats:
title: Plaats
x-stoplight:
id: wv6bi8bdfuxu3
type: object
properties:
'@type':
type: string
description: 'http://purl.org/dc/terms/Location'
plaatsnaam:
type: array
items:
$ref: '#/components/schemas/TaalString'
WoningBezettingsType:
type: object
title: WoningBezettingsType
x-stoplight:
id: rb7gf278qcyrv
enum:
- Verhuring
- Leegstand
properties:
'@type':
type: string
default: WoningBezettingsType
spelling:
type: string
taal:
type: string
AgentType:
title: AgentType
x-stoplight:
id: b3iwm5jjn8pft
type: object
properties:
'@type':
type: string
default: AgentType
spelling:
type: string
lang:
type: string
description: Persoon of organisatie die de woning zal huren
PersoonRegistratie:
title: PersoonRegistratie
x-stoplight:
id: 6fojgqsqwox32
type: object
properties:
'@type':
type: string
default: 'Huurder'
registratie:
$ref: '#/components/schemas/Identificator'
inkomen:
type: string
format: double
pattern: '[0-9]+\.?[0-9]*'
inkomensjaar:
type: integer
inkomenFictief:
type: boolean
OrganisatieRegistratie:
title: OrganisatieRegistratie
x-stoplight:
id: ozefub6q99za5
type: object
properties:
'@type':
type: string
default: 'https://data.vlaanderen.be/ns/organisatie'
registratie:
$ref: '#/components/schemas/Identificator'
wettelijkeNaam:
type: string
#----------------------- END CWR Woningbezetting payloads -------------------------------
#----------------------- START Notifications payloads -------------------------------
AsynchroonBerichtResponse:
type: object
properties:
version:
type: string
nullable: true
sender:
type: string
nullable: true
resource:
type: string
nullable: true
magdaResource:
type: string
nullable: true
description: Resource to be used on the MAGDA platform. This element is not present if the VMSW resource can not be parsed.
identification:
type: string
nullable: true
magdaIdentification:
type: string
nullable: true
description: Identification to be used on the MAGDA platform. This element is not present if the VMSW identification can not be parsed.
timeStamp:
type: string
format: date-time
changeType:
enum:
- C
- U
- D
type: string
description: Oplijsting mogelijke acties die via berichtenflow kan gebeuren.
changeReasonCode:
type: string
nullable: true
changeReasonComment:
type: string
nullable: true
receiver:
type: string
nullable: true
additionalProperties: false
#----------------------- END Notifications payloads -------------------------------
#----------------------- START Markthuurwaarden payloads --------------------------
Huurschatting:
type: object
properties:
woningKenmerkScores:
type: array
items:
$ref: '#/components/schemas/WoningKenmerkScore'
nullable: true
markthuurwaardePerSchattingsmodel:
type: array
items:
$ref: '#/components/schemas/MarkthuurwaardeSchattingsmodel'
nullable: true
additionalProperties: false
HuurschattingSimulatie:
type: object
properties:
woningKenmerkScores:
type: array
items:
$ref: '#/components/schemas/WoningKenmerkScore'
nullable: true
markthuurwaardePerSchattingsmodel:
type: array
items:
$ref: '#/components/schemas/MarkthuurwaardeSimulatieSchattingsmodel'
nullable: true
additionalProperties: false
Markthuurwaarde:
type: object
properties:
voorWoning:
type: string
format: uri
example: >-
https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}
nullable: true
magdaVoorWoning:
type: string
format: uri
nullable: true
description: Resource to be used on the MAGDA platform. This element is not present if the VMSW resource can not be parsed.
opReferentieDatum:
$ref: '#/components/schemas/Huurschatting'
opHuidigeStaat:
$ref: '#/components/schemas/Huurschatting'
additionalProperties: false
MarkthuurwaardeResponse:
type: object
properties:
'@context':
type: string
nullable: true
'@id':
type: string
format: uri
example: >-
https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}/markthuurwaarden
nullable: true
'@magdaId':
type: string
format: uri
nullable: true
'@type':
type: string
default: MarkthuurwaardeResource
nullable: true
value:
$ref: '#/components/schemas/Markthuurwaarde'
additionalProperties: false
MarkthuurwaardeSchattingsmodel:
type: object
properties:
'@type':
type: string
default: MarkthuurwaardeSchattingsmodelResource
nullable: true
bedragInclusiefAfwijkingEnAfronding:
type: integer
format: int32
toegestaneAfwijkingPercentage:
type: number
format: double
foutmelding:
type: string
nullable: true
jaar:
type: integer
format: int32
bedrag:
type: number
format: double
berekendOp:
type: string
format: date-time
additionalProperties: false
MarkthuurwaardeSimulatieResponse:
type: object
properties:
'@context':
type: string
nullable: true
'@id':
type: string
format: uri
nullable: true
'@magdaId':
type: string
format: uri
nullable: true
'@type':
type: string
default: MarkthuurwaardeSimulatieResource
nullable: true
value:
$ref: '#/components/schemas/HuurschattingSimulatie'
additionalProperties: false
MarkthuurwaardeSimulatieSchattingsmodel:
type: object
properties:
'@type':
type: string
default: MarkthuurwaardeSimulatieSchattingsmodelResource
nullable: true
jaar:
type: integer
format: int32
bedrag:
type: number
format: double
berekendOp:
type: string
format: date-time
additionalProperties: false
ProblemDetail:
type: object
properties:
type:
type: string
default: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/{Status}
nullable: true
title:
type: string
nullable: true
status:
type: integer
format: int32
detail:
type: string
nullable: true
instance:
type: string
nullable: true
additionalProperties: false
WoningKenmerkDefinitie:
type: object
properties:
'@id':
type: string
format: uri
example: /v1/woningkenmerken/{code}
nullable: true
'@magdaId':
type: string
format: uri
nullable: true
'@type':
type: string
default: WoningKenmerkDefinitieResource
nullable: true
label:
type: string
nullable: true
code:
type: string
nullable: true
additionalProperties: false
WoningKenmerkScore:
type: object
properties:
'@type':
type: string
default: WoningKenmerkScoreResource
nullable: true
woningKenmerk:
$ref: '#/components/schemas/WoningKenmerkDefinitie'
score:
type: string
description: >-
Waarde (score) voor het kenmerk. De waarde moet voldoen aan de
schaal die gekoppeld is aan het kenmerk.
nullable: true
additionalProperties: false
WoningKenmerkScoreLijst:
type: object
properties:
woningKenmerkSimulatieScores:
type: array
items:
$ref: '#/components/schemas/WoningKenmerkScoreWijziging'
nullable: true
additionalProperties: false
WoningKenmerkScoreWijziging:
type: object
properties:
code:
type: string
description: Code om het woningkenmerk uniek te identificeren
nullable: true
score:
type: string
description: >-
Score voor het kenmerk. De score moet voldoen aan de schaal die
gekoppeld is aan het kenmerk.
nullable: true
additionalProperties: false
#----------------------- END Markthuurwaarden payloads ----------------------------
#----------------------- START Conditiescore payloads ----------------------------
ConditiescoreWoningKenmerkScore:
type: object
properties:
'@type':
type: string
default: ConditiescoreWoningKenmerkScoreResource
nullable: true
readOnly: true
woningKenmerk:
$ref: '#/components/schemas/WoningKenmerkDefinitie'
score:
type: string
description: Score voor het kenmerk. De score moet voldoen aan de schaal die gekoppeld is aan het kenmerk.
nullable: true
readOnly: true
scoreLabel:
type: string
nullable: true
readOnly: true
wegingsfactorProcent:
type: number
format: double
totaalProcent:
type: number
format: double
additionalProperties: false
ConditiescoreGroep:
type: object
properties:
naam:
type: string
nullable: true
scores:
type: array
items:
$ref: '#/components/schemas/ConditiescoreWoningKenmerkScore'
nullable: true
wegingsfactorProcent:
type: number
format: double
totaalProcent:
type: number
format: double
additionalProperties: false
ConditiescoreCategorie:
type: object
properties:
naam:
type: string
nullable: true
groepen:
type: array
items:
$ref: '#/components/schemas/ConditiescoreGroep'
nullable: true
additionalProperties: false
Conditiescore:
type: object
properties:
voorWoning:
type: string
format: uri
example: >-
https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}
nullable: true
magdaVoorWoning:
type: string
format: uri
nullable: true
description: Resource to be used on the MAGDA platform. This element is not present if the VMSW resource can not be parsed.
gebouwstaat:
$ref: '#/components/schemas/ConditiescoreCategorie'
veiligheidEnGezondheid:
$ref: '#/components/schemas/ConditiescoreCategorie'
gebouwstaatScoreProcent:
type: number
format: double
gebouwstaatWegingsfactorProcent:
type: number
format: double
veiligheidEnGezondheidScoreProcent:
type: number
format: double
veiligheidEnGezondheidWegingsfactorProcent:
type: number
format: double
totaalScoreProcent:
type: number
format: double
ConditiescoreResponse:
type: object
properties:
'@context':
type: string
nullable: true
'@id':
type: string
format: uri
example: >-
https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}/conditiescore
nullable: true
'@magdaId':
type: string
format: uri
nullable: true
'@type':
type: string
default: ConditiescoreVoorWoningResource
nullable: true
value:
$ref: '#/components/schemas/Conditiescore'
ConditiescoreSimulatie:
type: object
properties:
gebouwstaat:
$ref: '#/components/schemas/ConditiescoreCategorie'
veiligheidEnGezondheid:
$ref: '#/components/schemas/ConditiescoreCategorie'
gebouwstaatScoreProcent:
type: number
format: double
gebouwstaatWegingsfactorProcent:
type: number
format: double
veiligheidEnGezondheidScoreProcent:
type: number
format: double
veiligheidEnGezondheidWegingsfactorProcent:
type: number
format: double
totaalScoreProcent:
type: number
format: double
additionalProperties: false
ConditiescoreSimulatieResponse:
type: object
properties:
'@context':
type: string
nullable: true
'@id':
type: string
format: uri
example: >-
https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/markthuurwaarden/simulatie#2023-04-13T16:15
nullable: true
'@type':
type: string
default: ConditiescoreSimulatieResource
nullable: true
value:
$ref: '#/components/schemas/ConditiescoreSimulatie'
additionalProperties: false
#----------------------- END Conditiescore payloads ----------------------------
#----------------------- START WoningKenmerken payloads -------------------------------
WoningKenmerkScoreWijzigen:
type: object
properties:
woningKenmerkScores:
type: array
items:
$ref: '#/components/schemas/WoningKenmerkScoreWijziging'
nullable: true
additionalProperties: false
WoningKenmerkScoresMetWoning:
type: object
properties:
voorWoning:
type: string
format: uri
example: /v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}
nullable: true
magdaVoorWoning:
type: string
format: uri
nullable: true
description: Resource to be used on the MAGDA platform. This element is not present if the VMSW resource can not be parsed.
scores:
type: array
items:
$ref: '#/components/schemas/WoningKenmerkScore'
nullable: true
additionalProperties: false
WoningKenmerkScoresResponse:
type: object
properties:
'@context':
type: string
nullable: true
'@id':
type: string
format: uri
example: /v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}/woningkenmerkscores
nullable: true
'@magdaId':
type: string
format: uri
nullable: true
'@type':
type: string
default: WoningKenmerkScoresMetWoningResource
nullable: true
value:
$ref: '#/components/schemas/WoningKenmerkScoresMetWoning'
additionalProperties: false
WoningKenmerkCategorie:
type: string
enum:
- Alles
- Huurschatting
- Energiecorrectie
- Conditiemeting
- ERP
- PV forfait
#----------------------- END WoningKenmerken payloads -------------------------------
#----------------------- START Energiecorrectie payloads ----------------------------
WoningEnergiecorrectieResponse:
type: object
properties:
'@context':
type: string
nullable: true
'@id':
type: string
format: uri
example: '{requestUrl}'
nullable: true
'@magdaId':
type: string
format: uri
nullable: true
'@type':
type: string
default: WoningEnergiecorrectieResource
nullable: true
value:
$ref: '#/components/schemas/WoningEnergiecorrectieResource'
additionalProperties: false
WoningEnergiecorrectieResource:
type: object
properties:
voorWoning:
type: string
format: uri
example: /v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}
nullable: true
magdaVoorWoning:
type: string
format: uri
nullable: true
referentieDatumHuur:
type: string
format: date
epcGegevens:
$ref: '#/components/schemas/EpcGegevensResource'
woningKenmerkScores:
$ref: '#/components/schemas/EnergiecorrectieWoningKenmerkScoresResource'
voorPeriode:
$ref: '#/components/schemas/EnergiecorrectieVoorPeriodeResource'
additionalProperties: false
EpcGegevensResource:
type: object
properties:
certificaatNummer:
type: string
nullable: true
epcType:
enum:
- EpcBestaand
- EpcBouw
type: string
epcKengetal:
type: number
format: double
ePeil:
type: number
format: double
kPeil:
type: number
format: double
datumEpc:
type: string
format: date
beschermdVolume:
type: number
format: double
totaleVerliesoppervlakte:
type: number
format: double
gemiddeldeUWaardeSchil:
type: number
format: double
energieVerbruikRuimteVerwarming:
type: number
format: double
energieVerbruikSanitairWarmWater:
type: number
format: double
brutoBruikbareVloerOppervlakte:
type: number
format: double
totaleOppervlakteVensters:
type: number
format: double
additionalProperties: false
EnergiecorrectieWoningKenmerkScoresResource:
type: object
properties:
energieDragerRuimteVerwarming:
$ref: '#/components/schemas/WoningKenmerkScore'
energieDragerSanitairWarmWater:
$ref: '#/components/schemas/WoningKenmerkScore'
additionalProperties: false
EnergiecorrectieVoorPeriodeResource:
type: object
properties:
datumVanaf:
type: string
format: date
datumTot:
type: string
format: date
dagenInPeriode:
type: number
format: double
maandenInPeriode:
type: number
format: double
bedragSanitairWarmWater:
type: number
format: double
bedragRuimteVerwarming:
type: number
format: double
bedragTotaalPeriode:
type: number
format: double
bedragTotaalPerMaand:
type: number
format: double
additionalProperties: false
EpcVersie:
type: string
enum:
- Huidig
- Referentie
#----------------------- END Energiecorrectie payloads ----------------------------
ErrorMessage:
required:
- detail
- title
type: object
properties:
type:
type: string
description: A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
title:
type: string
description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.
status:
type: string
description: The HTTP status code generated by the origin server for this occurrence of the problem.
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem.
instance:
type: string
description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
description: A representation of a generic error message
securitySchemes:
oauth2:
type: apiKey
description: "Standard Authorization header using the Bearer scheme. Example: \"bearer {token}\""
name: Authorization
in: header
|
