Element

Beschrijving

V/O

Opmerkingen

NISCode

V

Een gemeente kan enkel foto’s en documenten bewaren gekoppeld aan pand, entiteit, onderzoek, (deel)procedure voor haar eigen NIS-code volgens het adres van het pand. Voor personen gelden er geen restricties.

Het is beter de resultaten reeds te filteren in VLOK zelf op NIS-code (gemeente), ipv. dit pas later te laten doen door MAGDA. De NIS-code dient dus meegegeven te worden door MAGDA, tesamen met het zoekcriterium. De filtering wie de opvraging heeft gedaan (machtiging, rol gebruiker), is de verantwoordelijkheid van de gemeente zelf. Ook de logging dient gedaan te worden door de externe applicatie. Er wordt om privacy-redenen geen RR opname doorgegeven aan VLOK van gebruiker bij gemeente.

Bijlagen

De vraag bestaat uit het opslaan van foto’s of documenten. Het kan gaan over een aanmaak van een nieuw object, ofwel over een verwijdering van een bestaand object.

V

Eénduidige structuur in blokken (foto, document). Slechts 1 (één) foto of document mogelijk binnen 1 (één) object Bijlage.

Verschillende foto’s of documenten gelijktijdig, alsook combinatie.

Aantal items in 1 (één) bewaaractie is beperkt (max. 10 foto’s of tekeningen). Anders foutmelding met kleiner aantal gevraagd.

Er kunnen geen bestaande foto’s of documenten gewijzigd worden. Een bestaande foto of document kan wel verwijderd en terug aangemaakt worden (met wijzigingen).

Er is geen BewaarWKWBijlage op foto’s en documenten gekoppeld aan onderzoek. Onderzoeken kunnen (nog) niet ingebracht worden met webservices en daarom niet te bewaren (alsook gekoppelde foto’s en documenten).

Validatie volgens het XSD-schema is ingebouwd in beide richtingen. Er zijn een aantal basisregels voor validatie.

- Volgens het XDS-schema mag inhoud enkel worden doorgegeven als er ook iets inzit.

- Een verplicht veld in XSD moet ALTIJD meegegeven worden. Indien leeg mogelijk, dan mag in principe dit veld niet verplicht zijn. In de praktijk kan een verplicht veld wel met een lege waarde doorgegeven worden, doch dit is niet wenselijk.

- Een optioneel veld in XSD mag NOOIT doorgegeven worden indien leeg, zelfs niet met een lege waarde. Dus bij aanmaken nieuw pand, mag <Referte></Referte> niet doorgegeven worden indien optioneel veld.

- Indien je een bepaald optioneel veld niet meegeeft, dan zal dat veld leeg gemaakt worden zelfs indien dit veld reeds bestaande inhoud had.

- TijdstipLaatstGewijzigd in XSD is hier altijd een optioneel veld. Het is immers niet mogelijk bij een nieuw object reeds een TijdstipLaatstGewijzigd te hebben.

- Het veld Verwijder in XSD is steeds een verplicht veld.

Zelfde schrijfwijze (incl. hoofdletters, kleine letters) in XML-berichten, niet alleen de codes van de vaste waarden dus, maar ook de schrijfwijze van alle tags. <Veld></Veld> is niet <veld></veld>. Anders foutmelding of niet herkenning bij MAGDA.

Zelfde volgorde van tags in XML-berichten volgens XSD's (indien de tags niet in volgorde staan, slaat de webservice de tags over en worden de overgeslagen tags null).

Invulling van alle velden in een object of subobject, anders bij weglaten veld, dan wordt een veld als LEEG overschreven (zoals Locatie bij BewaarPand of Tel/Tel2/Email bij BewaarProcedure van Verzoeker).

Als je geen subobject meegeeft, dan wordt er niets gewijzigd (Adres, Capakey, Opp verhouding, GR, Betrokkene, Herindeling, Verzoeker, ...). Enige uitzondering is Risico, waar bij elke BewaarWKW actie alle velden met Type risico verwijderd en terug toegevoegd worden in VLOK, met dus wijziging van TijdstipLaatstGewijzigd.

Indien je de verwijdertag op 1 zet en een referte invult, dan zijn alle andere velden NVT (gecombineerd gebruik van aanmaken en verwijderen). De juiste timestamp dient ingevuld te zijn in het veld TijdstipLaatstGewijzigd.

TijdstipLaatstGewijzigd moet steeds ingevuld worden bij verwijderen van bestaande foto of document, anders foutmelding dat het veld TijdstipLaatstGewijzigd niet overeenkomt. Bij aanmaken van een nieuwe foto of document kan TijdstipLaatstGewijzigd weggelaten worden.

Code is steeds verplicht, Omschrijving optioneel. Indien Omschrijving ook opgegeven, dan steeds controle te doen tussen Code en Omschrijving volgens codetabellen (gecombineerd gebruik verplicht en exacte invulling, omschrijving is informatief bij BewaarWKW en BewaarWKWBijlage).

Foto

O

Geen aanmaken of verwijderen van foto van gesloopt pand of entiteit, of van heringedeelde/ herbestemde entiteit.

Verwijder

Verwijdervlag foto

(V)

Boolean

Verwijderen foto indien Verwijder = 1, TijdstipLaatstGewijzigd, Referte foto

TijdstipLaatstGewijzigd

Datum en tijdstip van mutatie foto

O

Formaat: jjjj-mm-ddTHH:MM:SS.sss

Naam

(V)

Een foto dient de naam van het bestand mee te geven.

Referte

O

Referte voor verwijderen foto. Geen referte = nieuwe foto.

ExterneReferte

O

Het veld ExterneReferte bij foto’s en documenten in de BewaarWKWBijlage request wordt enkel gebruikt als teruggaveveld ter info voor de BewaarWKWBijlage response. Het wordt niet opgeslagen in de VLOK databank en dus ook niet getoond bij overzicht foto’s en documenten in de GeefWKW response.

Bestand

(V)

Een bestand voor foto of document mag nooit groter zijn dan 4 MB. Indien wel, dan worden deze door DataPower al tegengehouden nog voor ze MAGDA bereiken, en wordt de verbinding met MAGDA verbroken. Er komt dan geen response tevoorschijn in BewaarWKWBijlage. Dit moet opgevangen worden in de externe applicatie die gebruik maakt van de VLOK webservices.

Type

(V)

Toegelaten formaten: JPG, PNG, TIFF, GIF … (afbeelding).

Data

(V)

Bestand voor foto’s en documenten in Base64 formaat.

Omschrijving

O

TagPand

(V)

TagEntiteit

Document

O

De webservicegebruiker dient maak- of oplaadrecht bij het documenttype te hebben voor minstens 1 (één) rol van de gemeente, van toepassing bij een document op het huidige moment voor aanmaken of verwijderen.

Verwijder

Verwijdervlag document

(V)

Boolean

Verwijderen of intrekken document indien Verwijder = 1, Referte document

Je kan documenten verwijderen of intrekken van een andere organisatie van eigen gemeente. Dit hangt af van de rechten bij documenttype welke organisaties mogen aanmaken/opladen (instelbaar in Documentbeheer DOPT van VLOK Online).

Als de configuratie van het documenttype aangeeft dat u het documenttype niet kunt verwijderen na het opladen, zal VLOK het document intrekken ipv. verwijderen. Zie voor uw rechten en de configuratie van documenttypes in VLOK Online.

TijdstipLaatstGewijzigd

Datum en tijdstip van mutatie document

O

Formaat: jjjj-mm-ddTHH:MM:SS.sss

Naam

(V)

Een document dient de naam van het bestand mee te geven.

Het document krijgt na de BewaarWKWBijlage echter een gegenereerde nieuwe naam bij de creatie van het document door VLOK zelf. Deze naam is dan te zien in de GeefWKW en GeefWKWBijlage response. De naamgeving start altijd met referte persoon, pand of entiteit. Het initieel veld Naam bij een document is dus niet relevant in de BewaarWKWBijlage request.

Referte

O

Referte voor verwijderen document. Geen referte = nieuw document.

ExterneReferte

O

Het veld ExterneReferte bij foto’s en documenten in de BewaarWKWBijlage request wordt enkel gebruikt als teruggaveveld ter info voor de BewaarWKWBijlage response opdat de gemeente zou weten over welk document het gaat. Het wordt niet opgeslagen in de VLOK databank en dus ook niet gebruikt bij overzicht foto’s en documenten in de GeefWKW response.

Bestand

(V)

Type

(V)

Toegelaten formaten: PDF, DWG (enkel voor DT149 grondplan), Mail.

Data

(V)

Bestand voor foto’s en documenten in Base64 formaat.

DocumentType

Zie rapport documenttypes

(V)

Om de VLOK-documenten te ordenen, groeperen we ze per documenttype (DT). Elke DT krijgt een nummer zodat snel duidelijk is over welk soort document het gaat. De DT’s zijn onderverdeeld in thema’s om bij het aanmaken of opladen snel het correcte DT te kunnen selecteren. In VLOK zitten een 160 tal documenttypes. Het is de toepassingsbeheerder van Wonen in Vlaanderen (WVL) die de configuratie van elk DT beheert. Alle gebruikers krijgen een overzicht via het rapport  Documentmodule - configuratie documenttypes. 

https://vlok.vlaanderen.be/handleiding/index.html#!Documents/welkedocumentenzijnerallemaalenwaarkanikzeaanmaken1.htm

Het rapport van documenttypes is beschikbaar in VLOK Online onder Mijn rapporten – Documentmodule – configuratie documentttypes: https://vlok.vlaanderen.be/reporting/. Om te kunnen inloggen als gemeente in VLOK Online dient met het afsprakenkader te ondertekenen, welke voorwaarden oplegt dat de gemeente in orde is met de informatieveiligheidsverplichtingen en dat de communicatie met Wonen-Vlaanderen digitaal verloopt.

Documenttypes zonder invulling van bestemmelingen/afzenders is toegelaten (instelbaar in Documentbeheer DOPT van VLOK Online).

Correspondenten

O

Correspondenten zijn afzenders/bestemmelingen bij documenten.

Check met afzenders/ bestemmelingen in het documenttype.

Voor derden (verzoeker, belangh, indiener, correspondent) RR-nr of KBO-nr ofwel naam + voornaam + correspondentieadres indien geen RR-nr of KBO-nr bekend (NAI). Bij correspondent is het mogelijk dat enkel naam opgegeven wordt (NAI).

Verplichte info bij een nieuwe correspondent:

- Als we de correspondent kennen met RRnummer of KBOnummer (bvb als HZR) dan geven we volgende gegevens door: RR/KBO (verplicht)

- Ofwel indien geen RRnummer of KBOnummer bekend, kan een niet authentieke identificatie (NAI) worden doorgegeven. Deze bestaat uit minstens: Naam, Correspondentieadres

- Het is ook mogelijk een NAI door te geven via de referte uit Vlok (ENKEL indien niet gekoppeld met RR/KBO !)

Om een correspondent aan te passen is de referte en TijdstipLaatstGewijzigd nodig. Volgende informatie kan dan aangepast worden: Naam, Voornaam, Correspondentieadres, E-mail, Telefoonnummer, Telefoonnummer2.

Je kunt altijd een persoon toevoegen met RR/KBO bij pand, entiteit of procedure. Als je RR/KBO niet weet, dan naam/voornaam/correspondentie adres. Bij nieuwe correspondent moet je ofwel RR/KBO ofwel naam/voornaam/correspondentie adres doorgeven. Als antwoord krijg je een referte persoon + TijdstipLaatstGewijzigd terug. Van dan af kun je een 2de XML-bericht opstarten met referte persoon + TijdstipLaatstGewijzigd en dan wijzigen en verwijderen van extra gegevens zoals naam, voornaam, correspondentieadres, tel/tel2/mail.

Identificatie

(V)

Alle gekoppelde correspondenten worden teruggegeven.

Het is niet mogelijk om RR en KBO en NAI tegelijk door te geven voor 1 (één) persoon.

Het veld Identificatie gebruikt bij Verzoeker of Correspondent is een VERPLICHT veld met RR/KBO of NAI (met of zonder ref persoon). Het veld Referte persoon (niet in NAI) is dus niet voldoende voor wijzigen of verwijderen van persoon. Indien er verschillende identificaties zijn opgegeven, dan foutmelding op het veld Identificatie (slechts 1 child element mogelijk).

We spreken over een authentieke identificatie wanneer een RR- of KBO-nummer gekend is.

Indien RR/KBO gekend: enkel RR/KBO.

Indien RR/KBO niet gekend (NAI):  Referte, Naam, Voornaam, Correspondentieadres.

INSZ

RR correspondent

(V)

Ondernemings nummer

KBO correspondent

Ondernemingsnr of vestigingseenheidsnr

NietAuthentieke Identificatie

Een niet authentieke identificatie (NAI) bevat minstens een naam en een correspondentieadres.

Omdat het momenteel niet mogelijk is om bij een NAI het type persoon mee te geven, is besloten dat bij deze ingave het steeds een natuurlijk persoon betreft. Dit wordt automatisch zo weggeschreven in de VLOK databank.

Bij correspondenten moet je wel direct correspondentieadres meegeven als je geen RR/KBO kent. Dan kan in VLOK Online opgezocht worden of die persoon reeds een referte heeft of een nieuwe referte moet krijgen.

Als in VLOK een persoon wordt gevonden met dezelfde naam, voornaam en adres (domicilieadres indien RR/KBO, correspondentieadres bij NAI), wordt aangenomen dat het om dezelfde persoon gaat en wordt deze persoon gekoppeld. Als we een lijst met gelijke personen vinden, kiezen we het eerste resultaat – de lijst wordt gesorteerd op referte (nieuwste eerst). Indien er een persoon met RR in de lijst aanwezig is, dan wordt deze persoon gekozen.

Referte

Unieke referte per persoon

(O)

Referte van gekoppelde correspondent met NAI.

Naam

(V)

Voornaam

(O)

Correspondentie adres

Generiek adrestype uit adressenregister (met eigen entiteitsnr + VlokID)

(V)

Correspondentieadres mogelijk indien NAI (niet authentieke identificatie), en mag NIET leeg zijn bij nieuwe correspondent, anders geen identificatie van persoon mogelijk in VLOK.

Een adres kan ofwel als CRABadres ofwel als vrije ingave weergegeven worden.

Een adres kan voorkomen als een CRABadres vanaf CRABcode straat. Indien enkel de CRABcode van de gemeente gekend is, beschouwen we dit als ‘vrije ingave’.

We houden enkel rekening met de CRABcode van het laagste niveau dat we vinden in de XML. Op basis van die code zoeken we de overeenkomende adresgegevens op. Extra info  in de bovenliggende velden negeren we. Onderliggende gegevens in tekst worden gewoon overgenomen. Indien voor een object de CRABcode en een teksttag wordt meegestuurd, houden we enkel rekening met de CRABcode.

Bijvoorbeeld CRAB-code van huisnummer is gekend als laagste CRABniveau. De gemeente geeft het volgende door:

- Huisnummer met CRABcode (verplicht)

- Busnummer met Busnummertag (optioneel)

We zoeken op basis van de CRABcode van de huisnummer het adres op. Het busnummer bewaren we in de VLOK databank zonder CRABcode

Bijvoorbeeld CRAB-code van straat is gekend als laagste CRABniveau. De gemeente geeft het volgende door:

- Postcode met Postcodetag (verplicht)

- Straatobject met CRABcode

- Huisnummer met Huisnummertag (verplicht)

- Busnumme met Busnummertag (optioneel)

We zoeken op basis van de CRABcode van de straat het adres op. Het huisnummer en busnummer bewaren we in de VLOK databank zonder CRABcode.

Bij een adres met vrije ingave  zijn alle velden behalve busnummer en land verplicht in te vullen:

- Landobject met NIScodetag verplicht indien bij het gemeenteobject geen CRABcode of NIScode wordt meegegeven. Indien bij het gemeenteobject een CRABcode of NIScode wordt meegegeven, wordt automatisch het land België weggeschreven. We doen in dat geval geen controle op dit veld.

- Gemeenteobject met CRABcode, NIScode of Gemeentenaam. Indien verschillende tags ingevuld werden, houden we enkel rekening met 1 veld in deze volgorde. (verplicht)

- Postcodeobject met Postcodetag (verplicht indien land = België)

- Straatobject  met Straattag (verplicht indien land = België)

- Huisnummerobject met Huisnummertag (verplicht indien land = België)

- Busnummerobject met Busnummertag (optioneel)

VlokId

(V)

VlokID wordt meegegeven voor update correspondentieadres. Geen VlokID = nieuw correspondentieadres.

Check op bestaand VlokID in VLOK (bij deze bestaande persoon!).

Indien geen invulling van VlokID met VlokAdres (= weglaten van adres persoon), dan blijft alles ongewijzigd qua correspondentieadres.

Indien geen invulling van VlokID, en wel invulling van VlokAdres, dan toevoeging van correspondentieadres (slechts 1 (één) correspondentieadres mogelijk per persoon).

Indien wel invulling van VlokID en VlokAdres, dan wijziging van bestaand adres gekoppeld aan VlokID.

VlokAdres

(V)

Verplichte invoer:

- Huisnummer of Busnummer indien CRABingave

- Postcode, Straat, Huisnummer voor Belgisch adres indien vrije ingave

- Gemeente (+ Land) voor niet-Belgisch adres indien vrije ingave

AdresObjectId

NVT

Uitfasering CRAB en migratie naar Gebouwen- en Adressenregister op basis van AdresObjectID vanaf 01/12/2023.

Geen rekening houden wegens CRABstandaard, dus ook niet verwerken of tonen. Wordt genegeerd indien het meegegeven wordt.

Land

O

Bij vrije ingave is NIScodetag voor land verplicht indien bij het gemeenteobject geen CRABcode of NIScode wordt meegegeven.

ISOCode

Zie ISO-codes van land

(V)

NISCode

Zie NIS-codes van land

Naam

Naam van land

Gemeente

O

Bij vrije ingave is CRABcode, NIScode of Gemeentenaam voor gemeente verplicht. Indien verschillende tags ingevuld werden, houden we enkel rekening met 1 veld in deze volgorde.

Indien bij het gemeenteobject een CRABcode of NIScode wordt meegegeven, wordt automatisch het land België weggeschreven. We doen in dat geval geen controle op dit veld.

NISCode

Zie NIS-codes van gemeente

(V)

CrabCode

Zie CRAB-adressenregister

Gemeente naam

Naam van gemeente

Postcode

O

Bij vrije ingave is postcodetag verplicht indien land = België.

CrabCode

(V)

Geen Crabcodes voor postcode.

Postcode

Straat

O

Bij vrije ingave is straattag verplicht indien land = België.

CrabCode

Zie CRAB-adressenregister

(V)

Straatnaam

Huisnummer

(V)

Bij vrije ingave is huisnummertag verplicht indien land = België.

Mogelijks geen huisnummer bij vrije ingave van buitenlands correspondentieadres voor persoon.

CrabCode

Zie CRAB-adressenregister

(V)

Huis nummer

Busnummer

O

CrabCode

Zie CRAB-adressenregister

(V)

Bus nummer

EigenNummer

NVT

Geen EigenNummer mogelijk voor adres persoon.

TijdstipLaatst Gewijzigd

Datum en tijdstip van mutatie adres

O

Formaat: jjjj-mm-ddTHH:MM:SS.sss

TijdstipLaatstGewijzigd

Datum en tijdstip van mutatie persoon

O

Formaat: jjjj-mm-ddTHH:MM:SS.sss

Referte

Unieke referte per persoon

O

Referte van gekoppelde correspondent met RR/KBO/NAI.

Indien RR/KBO én referte meegegeven wordt, moeten beide waarden over dezelfde persoon handelen.

Indien de referte bij NAI én de referte persoon bij tel/tel2/mail meegegeven wordt, moeten beide waarden over dezelfde persoon handelen.

Het wijzigen van een persoon is enkel mogelijk indien een referte en TijdstipLaatstGewijzigd wordt doorgegeven. Het betreft dus de velden Naam, Voornaam, Correspondentieadres, Tel/Tel2/Mail bij Verzoeker of Correspondent. Er wordt afgesproken dat bij NAI steeds referte persoon (NAI) en referte persoon bij tel/tel2/mail dienen opgegeven te zijn voor het wijzigen van een persoon. Immers kan een persoon zonder referte bij NAI reeds aanwezig zijn in VLOK Online, doch bij webservices kan er geen tussenliggend antwoord worden overgemaakt om te vergelijken met de referte persoon bij tel/tel2/mail.

Telefoon

O

Telefoon2

O

Email

O

Status

O

De status van een document bij de webservice BewaarWKWBijlage is steeds “Opgeladen”.

Omschrijving + Code

Opgeladen = 0

InOpmaak = 1

TerOndertekening = 2

Ondertekend = 3

Verwijderd = 4

Ingetrokken = 5

Aangemaakt = 6

TerManueleOndertekening = 7

O

Koppelingen

O

Er zijn koppelingen nodig om:

- Bij het aanmaken van een document de invulvelden te vervangen met de werkelijke data van het gekoppelde data-object.

- Documenten correct weer te geven onder de gekoppelde items bij het openen van het documentenoverzicht.

Onder koppelingen vindt u de verplichte of optionele koppelingen met de data-objecten (bv. Pand, Entiteit, Onderzoek, …) die VLOK zal tonen bij het aanmaken van een document. Alle entiteiten, onderzoeken, procedures mogen gekoppeld worden aan documenten, hier zijn geen restricties nodig (ze moeten uiteraard wel bij het pand horen).

Koppelingen zijn instelbaar in Documentbeheer in DOPT van VLOK Online:

- Minstens koppeling met pand

- Koppelingen moeten gelinkt zijn aan elkaar en volgen de boomstructuur zoals bij het documenttype

- Koppelingen zijn afhankelijk van het documenttype

- Enkel koppelingen die aangeduid zijn in het documenttype worden bewaard

- Verplichte koppelingen moeten doorgegeven worden 

- Optionele koppelingen mogen doorgegeven worden 

- Meervoudige koppelingen zijn mogelijk van zelfde type object

- Koppelingen die worden doorgegeven en niet aangeduid zijn in het documenttype worden genegeerd

Binnen de BewaarWKW webservice is het enkel mogelijk om aanpassingen te doen aan bepaalde procedures (enkel gestart via verzoek door gemeente zelf). Voor de koppelingen van documenten in de BewaarWKWBijlage webservice gaan we deze restrictie niet doorvoeren. Het is namelijk belangrijk dat gemeenten voor besluiten en opheffingen documenten aan alle procedures kunnen koppelen.

Referte

Unieke referte volgens type koppeling

(V)

Type

Pand = 1

Entiteit = 2

Onderzoek = 3

Correspondent = 4

Persoon = 5

ReactieHoorplicht = 6

ProcedureOo = 7

ProcedureCa = 8

DeelProcedureOo = 9

DeelProcedureCa = 10

Advies = 11

Beslissing = 12

BesluitNgw = 13

HoofdBeroep = 14

MinistrieelBesluit = 16

Conformiteitsattest OpEntiteit = 17

Conformiteitsattest

OpPand = 18

Dossier = 19

ProcesVerbaal = 20

Herstelvordering = 21

InstantieCorrespondent = 22

Vivoo = 23

DeelBeroep = 25

ProcedureKotlabel = 30

DeelProcedureKotlabel = 31

Beroepsprocedure = 40

Beroep = 41

Beroepsschrift = 42

OntwerpMB = 43

(V)

Bij de uitvoering van een aantal speciale Bewaaracties, dient er in een volgende stap nog een aantal verplichte documenten opgeladen te worden door de gemeente (met BewaarWKWBijlage), nodig voor aanvaarding van deze actie door Wonen in Vlaanderen:

HefbesluitenOp

- DT097 opheffingsbesluit OO

- DT100 opheffingsbesluit NGW

Verplichte koppelingen bij DT097: Entiteit, ProcedureOo, DeelProcedureOo

Verplichte koppelingen bij DT100: Entiteit, BesluitNgw

RegistreerNgw

- DT105 besluit NGW

Verplichte koppelingen bij DT105: Entiteit, ConformiteitsattestOpEntiteit

RegistreerCa

- DT114 CA woning + DT011 TV woning

- DT113 CA kamerwoning + DT012 TV kamer of DT014 TV kamer student

- DT115 CA seizoenarbeider + DT013 TV kamer SA

- DT600 CA arbeidskrachten + DT601 TV kamer AK

Verplichte koppelingen bij DT114, DT113, DT115, DT600, DT011, DT012, DT013, DT014, DT601: Entiteit

VerstuurBeslissingNaarWvl

- DT034 beslissing burgemeester

- DT043 melding geen besluit

- DT044 melding uitstel

Verplichte koppelingen bij DT034: Entiteit, DeelProcedureOo, Beslissing

Verplichte koppelingen bij DT043, DT044: Entiteit, ProcedureOo, Beslissing