Situering

Deze API laat toe om de gegevens van de woningen in het Centraal Woning Register (CWR) te consulteren en de beheren.

SHMs zijn decretaal verplicht om te koppelen aan een centraal woningregister (bij VMSW), en doelstelling is om vanaf oplevering van het project altijd een zicht te hebben op het actuele aanbod van woningen. Dit zal kunnen gebeuren door een integratie van de te ontwikkelen diensten binnen de softwaretoepassing van de verschillende sociale huisvestingsmaatschappijen. Zo kunnen de gegevens van de SHM's op structurele basis bezorgd kunnen worden aan de VMSW waar ze centraal worden bijgehouden.

Verwante diensten

• De API voor het consulteren en beheren van de Inschrijvingen in het Centraal Register

• De API voor het ontvangen van de notificaties bij het aanmaken, wissen of aanpassen van dossiers in het Centraal Register

Gegevensbronnen

De authentieke bron is hier Wonen in Vlaanderen met het Centraal Woningen Register.

Gebruiksvoorwaarden

Om gebruikt te kunnen maken van deze dienst dient men een machtiging te hebben die toegang geeft tot deze gegevens en een aansluitingsprocedure te doorlopen.

Functionaliteiten

Deze dienst is een Publicatie-service. Elke afnemer heeft de mogelijkheid om in samenspraak met Digitaal Vlaanderen te bepalen welke gegevens gevraagd worden, op basis van welke criteria deze geselecteerd moeten worden en met welke frequentie die zouden moeten aangeleverd worden.

De gegevens worden na publicatie beschikbaar gesteld op de MAGDA FTP server. De exacte locatie van deze folder en de naam wordt in samenspraak met Digitaal Vlaanderen bij aansluiting beslist. De folderstructuur en de manier waarop de gegevens opgehaald kunnen worden, wordt beschreven in de FTP richtlijnen.

In het geval er geen gegevens geselecteerd zouden worden, wordt er standaard geen bestand aangemaakt, tenzij de afnemer uitdrukkelijk vraagt om in dat geval toch een uitzonderingsbestand aan te leveren.

Werking

Werking

Scopes

• soczek_socHVCWR_v1_G

• soczek_socHVCWR_v1_P

• soczek_socHVCWR_v1_A

Verdeelde gegevens

De gegevens worden verdeeld op basis van de criteria die besproken worden tijdens het aansluitingsproces of voorafgaande gesprekken.

Verfijnde selecties zijn mogelijk, gelieve hiervoor contact op te nemen met de MAGDA Servicedesk.

Voorbeelden van dergelijke selecties: enkel ondernemingen uit eigen klantenlijst, ondernemingen uit bepaalde gemeente, … .

Opties

Volgende afleveropties kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:

• Compressie van het bestand in .zip

• Bundeling van bestanden (gezamelijke aflevering van meerdere publicaties)

• Compressie van de bundeling

• Borderelbestand (oplijsting afgeleverde bestanden, enkel mogelijk indien bundeling)

• Uitzonderingsbestand / leeg bestand (indien er geen gegevens te publiceren zijn, verkrijgt men toch een bestand)

• Controlebestand (bevat een md5, gebruikte encoding, gebruikte en volgende herstartdatum)

Opkuis & Logging

De gegevens in het bestand worden bewaard zoals beschreven op de pagina “MAGDA logging”.
Bestanden worden gedurende een beperkte tijd aangeboden op de FTP folder zoals beschreven in de FTP richtlijnen.

Beschikbaarheid

De periodiciteit van aanlevering via MAGDA is te bespreken tijdens het aansluitingsproces of voorafgaande besprekingen. Algemeen beschouwd is het mogelijk de gegevens dagelijks, wekelijks, … aan te bieden.

Ondersteunde talen

MAGDA ondersteunt de Nederlandse taal.Indien in de brongegevens de Nederlandse tekst niet beschikbaar is voor een bepaald element zal de eerste vertaling van de tekst in de brongegevens gebruikt worden, onafhankelijk van de taal waarin dit gegeven beschikbaar is.