Situering

De diensten onder het Sociale Huisvesting subdomein laten Sociale HuisvestingsMaatschappijen toe om de sociale woningen en hun (potentiële) huurders te beheren in databases die bij VMSW draaien.

Dit project bestaan uit een CIR en een CWR onderdeel. Deze staan voor Centraal Inschrijving Register en Centraal Woningen Register. Daarnaast zijn er notificatie diensten die meldingen vanuit de Azure Service Bus voor deze toepassingen doorgeven.

Werking

Onderstaand document omschrijft de functionele werking van de datastromen binnen het project. Dit document is aangeleverd door VMSW zelf en zal door hen onderhouden worden.

Beschikbare resources

CIR

Diensten :

• POST socZek/socialeHuisvesting/dossiers/zoeken - v1

• GET socZek/socialeHuisvesting/dossiers/dossier/{dossierNummer} - v1

• PUT socZek/socialeHuisvesting/dossiers/dossier/{dossierNummer} - v1

• POST socZek/socialeHuisvesting/bijlage - v1

• POST socZek/socialeHuisvesting/dossiers/bevestigDossierVerwerking - v1

• POST socZek/socialeHuisvesting/dossiers/wijzigDossierRangschikkingen - v1

• POST socZek/socialeHuisvesting/dossiers/partijInformatieWijzigingen - v1

• POST socZek/socialeHuisvesting/dossiers/verwerkDossierActie - v1

• GET socZek/socialeHuisvesting/gemeentes - v1

• GET socZek/socialeHuisvesting/gemeentes/wijkenVoorGemeente/{gemeenteNisCode} - v1

• PUT socZek/socialeHuisvesting/gemeentes/wijkenVoorGemeente/{gemeenteNisCode} - v1

CWR

Diensten :

• WoningAPI

  • GET socZek/socialeHuisvesting/woningen/{vmswWoningId}

  • PATCH socZek/socialeHuisvesting/woningen/{wmswWoningId}

  • GET socZek/socialeHuisvesting/woningen

  • POST socZek/socialeHuisvesting/woningen

• MarktHuurwaarden

  • GET socZek/socialeHuisvesting/woningen/{vmswWoningId}/markthuurwaarden

  • POST socZek/socialeHuisvesting/woningen/markthuurwaarden/simulatie

• Woningkenmerkenscores

  • PATCH socZek/socialeHuisvesting/woningen/{wmswWoningId}/woningkenmerkenscores

  • GET socZek/socialeHuisvesting/woningen/{wmswWoningId}/woningkenmerkenscores

• EnergieCorrectie

  • GET socZek/socialeHuisvesting/woningen/{vmswWoningId}/energiecorrectie

• Conditiescore

  • GET socZek/socialeHuisvesting/woningen/{vmswWoningId}/conditiescore

  • POST socZek/socialeHuisvesting/woningen/conditiescore/simulatie

Notificaties

Diensten :

• POST DELETE socZek/socialeHuisvesting/notificaties/{registerId}/messages/headPUT {messageId}/{lockToken}

• POST socZek/socialeHuisvesting/notificaties/{registerId}/messages/{messageId}/{lockToken}DELETE head

• PUT socZek/socialeHuisvesting/notificaties/{registerId}/messages/{messageId}/{lockToken}

• DELETE socZek/socialeHuisvesting/notificaties/{registerId}/messages/head

Verwante diensten

Er zijn geen verwante diensten buiten het Sociale Huisvesting functioneel domein.

Gegevensbronnen

De gegevens worden beheerd bij VMSW en in de Azure Service Bus implementatie van VMSW

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.

Responsetijden & Beschikbaarheid

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".

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.