DIGITAAL VLAANDEREN
GET socZek/socialeHuisvesting/dossiers/dossierMetBijlages/{dossierNummer} - OBSOLETE
- Bert Van Kets
- Jan Willem
Deze dienst staat als “Obsolete” bij de bron. Om de bijlagen op te vragen dient nu de POST socZek/socialeHuisvesting/bijlageUNDEFINED dienst gebruikt te worden.
Situering
Mensen kunnen zich inschrijven bij verschillende sociale huisvestingsmaatschappijen om op een lijst te komen om in aanmerking te komen voor een sociale woning. Die lijsten worden ook lokaal, decentraal bijgehouden bij de verschillende SHM's. SHM's houden nu zelf bij wie bij hun op de lijst staat als kandidaat huurder, en een burger kan overal op de lijst komen, waardoor er dus geen zicht is op het aantal unieke aanvragen. Deze lijst moet ook gecentraliseerd worden vandaar dat de kandidaat huurders zich bij de VMSW dienen in te schrijven (normaal vanaf 1/1/2023). De VMSW zal deze gegevens vervolgens door middel van de te ontwikkelen REST services aan de verschillende SHM's bezorgen. De VMSW is in deze bron; de SHM's zijn afnemer.
Geeft de detail informatie van een welbepaald dossier terug, inclusief de inhoud van de bijlages. De bijlages zijn gecodeerd in BASE64 en kunnen elk maximaal 10MB zijn met een maximum van 50MB allemaal samen.
Vraag
Parameters
Naam | Type | Verplicht | Omschrijving |
|---|---|---|---|
x-correlation-id | Header | Ja | Referte (uuid) om de actie uniek te identificeren |
dossierNummer | Path | Ja | De identificatie van het dossier |
Validaties
Er zijn geen specifieke validatie in de request
Inhoud
De request heeft geen payload
Antwoord
Inhoud
Element | Omschrijving | |||
|---|---|---|---|---|
dossierStatusHistoriek | Array van elementen | |||
| statusCodeVan | Mogelijke waarden :
| ||
| statusCodeTot | Mogelijke waarden :
| ||
| actie | Mogelijk waarden:
| ||
| statusDatum | Datum waarop de actie is ingevoerd. Het formaat is een geldig date-time formaat volgens RFC 3339. De offset is in CET of CEST zijn volgens de Belgische zomer- of wintertijd. | ||
| partijCode | KBO nummer (enkel 10 cijfers) | ||
| commentaar | Notificatie door de gebruiker | ||
dossierInkomstenSamenvattingen | - | |||
| totaalInkomsten | Som van alle inkomsten | ||
| totaalInkomstenGeindexeerd | Geïndexeerde som van alle inkomsten | ||
| dossierInkomstenSamenvattingen | Array van elementen | ||
|
| inkomstenJaar | Jaar van het referentie-inkomen | |
|
| belastbaarInkomenAanwezigheidCode | Dit veld geeft aan of er inkomen (FOD Financiën) gevonden werden bij de authentieke bron en/of ze opgenomen worden in het CIR. Mogelijke waarden:
| |
|
| belastbaarInkomenJaarTotaal | Geeft aan hoeveel het totale belastbare inkomen bedraagt op jaarbasis. | |
|
| leefLoonAanwezigheidCode | Dit veld geeft aan of er leefloongegevens gevonden werden bij de authentieke bron en/of ze opgenomen worden in het CIR. Mogelijke waarden:
| |
|
| leefLoonJaarTotaal | Geeft aan hoeveel het totale leefloon bedraagt op jaarbasis. | |
|
| inkomensVervangendeTegemoetkomingCode | Dit veld geeft aan of er inkomen vervangende-gegevens gevonden werden bij de authentieke bron en/of ze opgenomen worden in het CIR. Mogelijke waarden:
| |
|
| inkomensVervangendeTegemoetkomingJaarTotaal | Geeft aan hoeveel het totale leefloon bedraagt op jaarbasis. | |
|
| inkomensPensioenJaarTotaal | Geeft aan hoeveel pensioen het gezinslid krijgt | |
|
| extraBeroepsBuitenlandInkomstenJaarTotaal | Geeft het niet geïndexeerde bedrag van het buitenlandsinkomen | |
|
| extraBeroepsInstellingenInkomenstenJaarTotaal | Geeft het niet-geïndexeerde inkomensbedrag uit Europese of internationale instellingen | |
|
| rijksregisternummer | Rijksregisternummer gekoppeld aan een dossier. | |
dossierPersonen | Array van elementen | |||
| contactTypeCode | Mogelijke waarden :
| ||
| contactAardCode | Mogelijke waarden :
| ||
| geboorteDatum | Geboortedatum | ||
| rijksregisternummer | Rijksregisternummer | ||
| voorNaam | Voornaam van contact/gezinslid | ||
| naam | Achternaam van het contact/gezinslid | ||
| genderCode | Mogelijke waarden :
| ||
| burgelijkeStaatCode | Mogelijke waarden :
| ||
| mantelzorgGeefCode | Mantelzorg Code (CARE) Mogelijke waarden :
| ||
| mantelzorgGeefPostCode | Dit is de postcode van de gemeenten van de derde die mantzorg geeft aan of krijgt van het gezinslid. | ||
| mantelzorgKrijgCode | Mantelzorg Code (CARE) Mogelijke waarden :
| ||
| mantelzorgKrijgPostCode | Dit is de postcode van de gemeenten van de derde die mantzorg geeft aan of krijgt van het gezinslid. | ||
| taalkennisCode | Resultaat van authentieke bron Mogelijke waarden :
| ||
| taalkennisSneltestCode | Code die aangeeft hoe goed de talenkennis is van het contact/gezinslid. Mogelijke waarden :
| ||
| E-mailadres van het contact/gezinslid | |||
| telefoon1 | Telefoonnummer van het contact/gezinslid | ||
| telefoon2 | Telefoonnummer van het contact/gezinslid | ||
| adressen |
| ||
|
| contactVoorkeurCode | Wat als contactadres gebruikt mag worden Mogelijke waarden:
| |
|
| domicilie |
| |
|
|
| postCode | Postcode van de woning van het contact/gezinslid |
|
|
| gemeente | Naam van de gemeente waar het adres gevestigd is. |
|
|
| gemeenteNisCode | NISCode van de gemeente van domicilie |
|
|
| landCode | NISCode van het land van domicilie. |
|
|
| straat | Naam van de straat waar de woning gevestigd is. |
|
|
| huisNummer | Huisnummer waar de woning gevestigd is. |
|
|
| huisNummerBus | Bus van woning. |
|
| verblijf |
| |
|
|
| postCode | Postcode van de woning van het contact/gezinslid |
|
|
| gemeente | Naam van de gemeente waar het adres gevestigd is. |
|
|
| gemeenteNisCode | NISCode van de gemeente het verblijfsadres |
|
|
| landCode | NISCode land van het verblijfsadres. |
|
|
| straat | Naam van de straat waar de woning gevestigd is. |
|
|
| huisNummer | Huisnummer waar de woning gevestigd is. |
|
|
| huisNummerBus | Bus van woning. |
|
| contact |
| |
|
|
| postCode | Postcode van de woning van het contact/gezinslid |
|
|
| gemeente | Naam van de gemeente waar het adres gevestigd is. |
|
|
| gemeenteNisCode | NISCode van het contactadres |
|
|
| landCode | Niscode land van het contactadres. |
|
|
| straat | Naam van de straat waar de woning gevestigd is. |
|
|
| huisNummer | Huisnummer waar de woning gevestigd is. |
|
|
| huisNummerBus | Bus van woning. |
| beperkingMutualiteitErkenningCode | Dit veld geeft weer of het gezinslid een erkende handicap/beperking heeft volgens de FOD personen met een handicap. Mogelijke waarden:
| ||
| verblijfsAdresCode | Geeft aan waar het gezinslid verblijft. Mogeljke waarden:
| ||
| contactInvaliditeitCode | Geeft aan of er invaliditeitsgegevens gevonden werden bij de authentieke bron en/of ze opgenomen worden in het CIR. Mogelijke waarden:
| ||
| werkzaamheidGeschiedenisCode | Geeft aan of de persoon in de laatste 6 maand gewerkt heeft of niet. Wordt enkel gevraagd wanneer belastbaar inkomen niet gekend is Mogelijke waarden:
| ||
| contactSubTypeCode | Geeft aan welk type bijwoner het gezinslid is. Mogelijke waarden:
| ||
| contactAantalKinderenCode | Geeft bij een zwangerschap aan over hoeveel kinderen er verwacht worden. Mogelijke waarden:
| ||
| contactPersoonTenLaste | Mogelijke waarden:
| ||
| contactErkenningAfhankelijk | Array van elementen Geeft aan of de financiële afhankelijkheid erkend is. Mogelijke waarden:
| ||
| registratieContactErkenningInformatieVoorKind | Bijkomende info uit KSZ rond handicap voor een kind | ||
| registratieContactErkenningInformatieVoorVolwassenen | Bijkomende info uit KSZ rond handicap voor een volwassene | ||
| bewindvoerderCode | Code die aangeeft of de persoon onder bewindvoering is of niet. Mogelijke waarden:
| ||
| bewindvoerderRijksregisternummer | Rijksregisternummer van bewindvoerder (indien bekend) | ||
| verbondenAanVennootschap | Geeft aan of de kandidaat-huurder verbonden is aan een vennootschap volgens de authentieke bronnen. Mogelijke waarden:
| ||
dossierLocatieVoorkeuren | Locatie Voorkeuren | |||
| gemeenteNisCode | Geeft de NIScode van de gemeente weer, waar de Kandidaat-huurder wil wonen. | ||
| wijken | Geeft de wijk van de gemeente/deelgemeenten weer, waar de Kandidaat-huurder wil wonen. | ||
| sorteerIndex | Sortering van de vragen | ||
dossierOptioneleVoorkeuren | Locatie Voorkeuren | |||
| partijCode | KBO nummer (enkel 10 cijfers) of CIR code of rijksregisternummer van de partij die betrokken is bij het dossier.KBO nummer of CIR code van de partij die betrokken is bij het dossier. | ||
| optioneleVoorkeurVraagCode | Mogelijke waarden:
| ||
| optioneleVoorkeurAntwoordCode | Antwoord op voorkeurvragen Mogelijke waarden (element is een string, geen enum) :
| ||
dossierEigendommen | Array van elementen | |||
| rijksregisternummer | Rijksregisternummer gekoppeld aan een eigendom. | ||
| eigendomTypeCode | Eigendom Type (= Recht Aard) Code (ROTP) Mogelijke waarden:
| ||
| eigendomAardCode | Eigendom Aard Code (ROKD) Mogelijke waarden:
| ||
| waarde | Het percentage van de woning die de persoon bezit. | ||
| perceelID | Perceel identificatie | ||
| justificatie | Opmerking van de kandidaat huurder bij een gekende eigendom | ||
| justificatieDeclaratie | Opmerking van de kandidaat huurder bij het aangeven van een eigendom | ||
| straat | Straatnaam van het onroerend goed. | ||
| huisNummer | Huisnummer van de woning | ||
| gemeente | Gemeente waarin het onroerend goed zich bevindt | ||
| postCode | Postcode van de gemeente waarin het onroerend goed zich bevindt | ||
| gemeenteNisCode | NISCode van de gemeente waarin het onroerend goed zich bevindt | ||
| landCode | NISCode van het land waarin het onroerend goed zich bevindt | ||
dossierDienstDossierDomicilieHistoriek | Array van elementen | |||
| landCode | NISCode van het land waar het gezinslid verbleef | ||
| rijksregisternummer | Rijksregisternummer gekoppeld aan een dossier. | ||
| postCode | Postcode van het adres waar het gezinslid verbleef. | ||
| gemeente | Gemeente het gezinslid verbleef. | ||
| gemeenteNisCode | NISCode van de gemeente waar het gezinslid verbleef. | ||
| straat | Naam van de straat waar het gezinslid verbleef. | ||
| huisNummer | Huisnummer van de woning waar het gezinslid verbleef. | ||
| huisNummerBus | Busnummer van de woning waar het gezinslid verbleef. | ||
| beginDatum | Begindatum vanaf wanneer het gezinslid in de woning verbleef | ||
| eindDatum | Einddatum tot wanneer het gezinslid in de woning verbleef. Het formaat is een geldig date-time formaat volgens RFC 3339. De offset is in CET of CEST zijn volgens de Belgische zomer- of wintertijd. | ||
dossierBijlages | Array van elementen | |||
| bestandNaam | Naam van het bestand | ||
| bestandGrootte | Grootte van het bestand | ||
| bestandExtensieCode | Mogelijke waarden:
| ||
| identificatie | Uniek nummer die aan de bijlage gegeven wordt. Begint met Bijlage code+cijfer+RRN | ||
| indentificatieRijksregisternummer | Rijksregisternummer van de persoon voor wie de bijlage is. | ||
| identificatieBestandCode | Identificatie Bestand Code Mogelijke waarden:
| ||
| identificatieBestandIndex | Index van bestanden, volgorde wanneer er per persoon meerdere bestanden opgeladen worden. | ||
| bestand | Bestand in BASE64 formaat. Elk bestand heeft een maximaal formaat van 10MB. Het maximaal formaat van alle bestanden samen is 50MB. | ||
| opmerking | Opmerkingen die bij het bestand kunnen worden toegevoed. | ||
| bijlageDatum | Datum waarop de bijlage is toegevoegd. Het formaat is een geldig date-time formaat volgens RFC 3339. De offset is in CET of CEST zijn volgens de Belgische zomer- of wintertijd. | ||
| aanvaardingBijlageCode | Mogelijke waarden:
| ||
dossierBetrokkenPartijen | Array van elementen Alle betrokken partijen(primaire/secundaire verhuurders) | |||
| partijTypeCode | Mogelijke waarden:
| ||
| partijRolCode | Mogelijke waarden:
| ||
| partijIdentificatie | Ondernemingsnummer van de WM, RRN voor KH | ||
| postCode | Postcode van de hoofdzetel WM | ||
| gemeente | Gemeentenaam van de hoofdzetel WM | ||
| gemeenteNisCode | NISCode van de gemeente van de hoofdzetel WM | ||
| straat | Straanaam van de hoofdzetel WM | ||
| huisNummer | Huisnummer van de hoofdzetel WM | ||
| huisNummerBus | Busnummer van de hoofdzetel WM | ||
bewindvoerder |
| |||
| rijksregisternummer | Rijksregisternummer van bewindvoerder | ||
| voorNaam | Voornaam van de bewindvoerder | ||
| naam | Naam van de bewindvoerder | ||
| E-mail adres van de bewindvoerder | |||
| telefoon1 | Telefoonnummer van de bewindvoerder | ||
| telefoon2 | Telefoonnummer van de bewindvoerder | ||
| postCode | Postcode van het adres van de bewindvoerder | ||
| gemeente | Naam van de gemeente van het adres van de bewindvoerder | ||
| gemeenteNisCode | NISCode van de gemeente van het adres van de bewindvoerder | ||
| landCode | NIScode vna het land van het adres van de bewindvoerder | ||
| straat | Straatnaam van het adres van de bewindvoerder | ||
| huisNummer | Huisnummer van het adres van de bewindvoerder | ||
| huisNummerBus | Busnummer van het adres van de bewindvoerder | ||
oudDossier |
| |||
| oudDossierNummer | Oud dossiernummer | ||
| partijCode | WM of CIR (CIR om het dossierNummer bij inschrijving te bewaren wanneer het dossier een nieuw dossiernummer gekregen heeft na validatie WM) | ||
aanvaardingDossiers | Array van elementen | |||
| aanvaardingTypeCode | Mogelijke waarden:
| ||
| aanvaardingCode | Mogelijke waarden:
| ||
| opmerking | Opmerking bij de aanvaarding | ||
dossierZwarteLijsten | Array van elementen | |||
| partijIdentificatie | Rijksregisternummer voor KH | ||
| reden | Mogelijke waarden:
| ||
| datum | Datum waarop de persoon op de zwarte lijst gezet is. Het formaat is een geldig date-time formaat volgens RFC 3339. De offset is in CET of CEST zijn volgens de Belgische zomer- of wintertijd. | ||
dossierPanden | Array van elementen | |||
| postCode | Postcode van het aangeboden pand | ||
| gemeente | Naam van de gemeente van het aangeboden pand | ||
| gemeenteNisCode | NISCode van de gemeente van het aangeboden pand | ||
| straat | Straat van het adres van het aangeboden pand | ||
| huisNummer | Huisnummer van het adres van het aangeboden pand | ||
| huisNummerBus | Busnummer van het adres van het aangeboden pand | ||
| landNisCode | NISCode van het land | ||
| pandAanbiedingStatus | Mogelijke waarden:
| ||
| partijCode | KBO nummer (enkel 10 cijfers) | ||
| aanbiedingsDatum | Datum van aanmaak van de aanbieding | ||
| statusDatum | Datum van de laatste statuswijziging. Het formaat is een geldig date-time formaat volgens RFC 3339. De offset is in CET of CEST zijn volgens de Belgische zomer- of wintertijd. | ||
dossierHuidigInkomen | Array van elementen | |||
| rijksregisternummer | Rijksregisternummer gekoppeld aan een dossier. | ||
| authentiekebron | Array van elementen | ||
|
| inkomenType | Mogelijke waarden:
| |
|
| jaarMaand | Jaar + maand van het inkomen | |
|
| bedrag | Bedrag inkomen in euro, 2 cijfers na de komma. | |
| gewerktLaatste6Maand | Geeft per maand aan of de kandidaat-huurder werkte of niet (t= heeft gewerkt, f= heeft niet gewerkt). | ||
| schuldenregeling | Aanduiding of de kandidaat-huurder in een collectieve schuldenregeling, in budgetbegeleiding of in budgetbeheer is Mogelijke waarden:
| ||
| onderhoudsgelden |
| ||
dossierNummer | Dossiernummer | |||
dossierType | Mogelijke waarden:
| |||
statusCode | Mogelijke waarden:
| |||
woningVoorkeuren | Woning voorkeuren voor het dossier | |||
| maximaalHuurBedrag | Maximaal bedrag van de huur | ||
| maximaalHuurlast | Maximale huurlast die de kandidaathuurder wenst te betalen | ||
| minimumAantalKamers | Minimum aantal kamers | ||
| maximumAantalKamers | Maximum aantal kamers | ||
| woningTypeCode | Array van elementen Mogelijke waarden:
| ||
| lichamelijkeBeperkingCode | Of de kandidaat huurder een aangepaste woning wenst aan medische noden Mogelijke waarden:
| ||
inschrijving | Inschrijvingsdata van het dossier | |||
| hulpCode | Inschrijfhulp Code (RAOP) Mogelijke waarden:
| ||
| hulpInformerenCode | Inschrijfhulp Informeren Code (PKIS) Mogelijke waarden:
| ||
| hulpNaam | Naam van organisatie die de kandidaat huurder hielp inschrijven | ||
| hulpEmail | Emailadres van de inschrijfhulp | ||
| datum | Eerste indieningsdatum van het dossier. Het formaat is een geldig date-time formaat volgens RFC 3339. De offset is in CET of CEST zijn volgens de Belgische zomer- of wintertijd. | ||
schrapping | Schrappinginformatie binnen het dossier | |||
| datum | Datum van schrapping van het dossier. Het formaat is een geldig date-time formaat volgens RFC 3339. De offset is in CET of CEST zijn volgens de Belgische zomer- of wintertijd. | ||
| redenCode | Array van elementen Schrapping Redenen (RCNC) Mogelijke waarden:
| ||
woningNood | Woningnood voor het dossier | |||
| redenCode | Mogelijke waarden:
| ||
| omschrijving | Woningnood reden omschrijving | ||
| identificatie | Identificatienummer van woonnood. | ||
versieNummer | Versie nummer van dit dossier | |||
mogelijkeActies | Array van elementen Mogelijke acties op het dossier Mogelijke waarden:
| |||
inkomenVoorwaardeStatusCode | Resultaat van de automatische controle Mogelijke waarden:
| |||
eigendomVoorwaardeStatusCode | Resultaat van de automatische controle Mogelijke waarden:
| |||
tijdstipLaatsteHandeling | Tijdstip waarop het dossier het laatste werd behandeld door Kandidaat-huurder, Woonmaatschappij of automatische actie uit het CIR. | |||
volmachtWijzigingen | Geeft aan dat de primaire woonmaatschappij aanpassingen mag dus aan het dossier op vraag van de kandidaat-huurder. Mogelijk waarden:
| |||
Voorbeelden
Vraag
GET socZek/socialeHuisvesting/dossiers/dossierMetBijlage/2022.11.10.0003Antwoord
Op deze pagina
- 1 Situering
- 2 Vraag
- 2.1 Parameters
- 2.2 Validaties
- 2.3 Inhoud
- 3 Antwoord
- 4 Inhoud
- 5 Voorbeelden
Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren
De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid
uitgegeven door Digitaal Vlaanderen