Gebruik van de edit-API's: Adressen

Gebruik van de edit-API's: Adressen

Statusovergangen

draw.io Diagram
  • voorgesteld: Een adres heeft de status voorgesteld wanneer het wordt ingevoerd nog vóór er een vergunning met voorstel tot adressering werd verleend door de gemeenteraad of vooraleer het op het terrein in gebruik is.

  • inGebruik: Een adres heeft de status inGebruik wanneer het adres formeel is goedgekeurd door de gemeenteraad of voorkomt op een goedgekeurd officieel document en in gebruik is op het terrein.

  • afgekeurd: Een adres heeft de status afgekeurd wanneer het werd ingevoerd nog vóór er een vergunning met voorstel tot adressering werd verleend door de gemeenteraad en uiteindelijk de gemeenteraad besloot dit adres niet goed te keuren.

  • gehistoreerd: Een adres heeft de status gehistoreerd wanneer de gemeenteraad beslist dat het adres niet langer in gebruik is en het dus wordt opgeheven.

Opmerking: een adres kan ook verwijderd worden, maar dit wordt niet aanzien als een statusovergang, aangezien dit enkel gebeurt wanneer het adres foutief is aangemaakt.

 

In onderstaande tabel worden alle mogelijke statuscombinaties getoond tussen straatnamen en adressen:

 

Adres status

Straatnaam status

voorgesteld

inGebruik

afgekeurd

gehistoreerd

voorgesteld

(1)

inGebruik

afgekeurd

-

-

gehistoreerd

-

-

(1) Een adres in de status inGebruik zou in principe niet mogen voorkomen in een straatnaam met de status voorgesteld. Om praktische redenen gebeurt dit uitzonderlijk wel, maar deze situatie zou nooit lang mogen duren.

 

In onderstaande tabel worden alle mogelijke statusovergangen bij een straatnaam en de invloed op de onderliggende adressen getoond:

 

Adres status

Straatnaam statuswijziging

voorgesteld

inGebruik

afgekeurd

gehistoreerd

voorgesteld → inGebruik (goedkeuren)

voorgesteld

inGebruik

afgekeurd

gehistoreerd

inGebruik → voorgesteld (goedkeuring corrigeren)

voorgesteld

inGebruik

afgekeurd

gehistoreerd

voorgesteld → afgekeurd (afkeuren)

afgekeurd

gehistoreerd

afgekeurd

gehistoreerd

afgekeurd → voorgesteld (afkeuring corrigeren)

-

-

afgekeurd

gehistoreerd

inGebruik → gehistoreerd (opheffen)

afgekeurd

gehistoreerd

afgekeurd

gehistoreerd

gehistoreerd → inGebruik (opheffing corrigeren

-

-

afgekeurd

gehistoreerd

 

Business rules en validatieregels endpoints

Overkoepelend

BR_1 Een decentrale beheerder kan enkel adressen beheren binnen zijn eigen gemeente. Hij kan hiervoor enkel straatnamen gebruiken uit zijn gemeente. Een centrale beheerder kan dit overal.

BR_2 Een adres moet voldoen aan de richtlijnen van BestAdd: https://belgif.be/page/activity/bestwg.nl.html.

Stel een adres voor

API-documentatie

Decentrale beheerders die adressen maximaal wensen te beheren, willen adressen kunnen invoeren nog voor een vergunning met voorstel tot adressering werd verleend door de gemeente. Deze adressen kunnen worden ingevoerd met status voorgesteld, daar ze nog niet in gebruik zijn op het terrein, en daar ze nog niet voorkomen op een document dat door de gemeente werd goedgekeurd.

BR_3 Een huisnummer moet het correcte formaat hebben:

  • minimaal 1 karakter

  • maximaal 10 karakters

  • voldoet aan de reguliere expressie ^[1-9]([0-9]{0,8}([A-H]|[K-N]|[P]|[R-T]|[V-Z]){0,1}|[0-9]{0,9})$

    • Huisnummers 45, 2C of 7563M zullen aanvaard worden, maar huisnummers 045, 2I, 5BIS of 4a niet.

    • Voor een centrale beheerder geldt:

      • ^[A-Z0-9](?:.{0,8}[A-Z0-9])?$

      • Er is geen beperking op welke letters mogen gebruikt worden, maar dit wordt enkel als uitzondering toegestaan.

BR_4 Een busnummer moet het correcte formaat hebben:

  • minimaal 1 karakter

  • maximaal 10 karakters

  • voldoet aan de reguliere expressie ^(?!^[./]|.*[./]$)(?!.*[./]{2,})[a-zA-Z0-9./]{1,10}$

    • Voor een centrale beheerder geldt:

      • ^(?=.{1,10}$)-?(?:[A-Za-z0-9]|[A-Za-z0-9].*[A-Za-z0-9])$

  • de strings ‘bus’, ‘Bus’ en ‘BUS’ vormen geen substring van het busnummer

  • Busnummers 1, 001, 5C,1.1 zullen aanvaard worden, maar busnummers 0, Bus 1, 1-A, 12..1 niet.

BR_5 De postcode van een voorgesteld adres moet bestaan en:

  • de status gerealiseerd hebben

  • behoren tot een gemeente waartoe de straatnaam van het adres behoort

BR_6 Bij een adres met een busnummer moet de postcode dezelfde zijn als bij het adres zonder busnummer.

BR_7 De straatnaam van een voorgesteld adres moet bestaan en de status voorgesteld of inGebruik hebben.

BR_8 Een adres dat wordt voorgesteld is altijd officieel toegekend.

BR_9 Een adres moet een geldige positie hebben. De positie van het adres moet ook binnen de gemeentegrenzen liggen van de gemeente die de gekoppelde straatnaam heeft toegekend, met een bijkomende buffer van 10 meter. De validatie op de gemeentegrenzen gebeurt niet door de API, maar moet voorzien worden door de applicatie die de API’s gebruikt.

BR_10 Een adres met een busnummer kan enkel voorgesteld worden als er ook een adres bestaat in de status voorgesteld of inGebruik met hetzelfde huisnummer zonder het busnummer.

BR_11 Er mogen geen 2 adressen in de status voorgesteld of inGebruik bestaan met een gelijk huisnummer en busnummer in dezelfde straat.

BR_12 Bij het voorstellen van een adres is het attribuut positieGeometrie verplicht en moet 1 van deze waarden hebben: aangeduidDoorBeheerder of afgeleidVanObject.

BR_13 Bij het voorstellen van een adres is het attribuut positieSpecificatie verplicht en moet 1 van deze waarden hebben: perceel, lot, standplaats, ligplaats, gebouweenheid of ingang.

BR_14 Wanneer bij het voorstellen van een adres het attribuut positieGeometrie gelijk is aan aangeduidDoorBeheerder dan moet het attribuut positieSpecificatie de waarde lot, standplaats, ligplaats of ingang hebben.

Wanneer bij het voorstellen van een adres het attribuut positieGeometrie gelijk is aan afgeleidVanObject dan moet het attribuut positieSpecificatie de waarde perceel of gebouweenheid hebben.

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Het veld postinfoId/straatnaamId/huisnummer/positieGeometrieMethode/positieSpecificatie/positie niet/leeg/onbestaande waarde meegegeven

Error 400

JsonInvalid

Json is not valid.

BR_12 BR_13

Huisnummer voldoet niet aan regex huisnummer

Error 400

AdresOngeldigHuisnummerformaat

Ongeldig huisnummerformaat.

BR_3

Busnummer voldoet niet aan regex busnummer

Error 400

AdresOngeldigBusnummerformaat

Ongeldig busnummerformaat.

BR_4

Onbestaand postinfoId meegegeven

Error 400

AdresPostinfoNietGekendValidatie

De postinfo 'postinfoId' is niet gekend in het postinforegister.

BR_5

Onbestaand straatnaamId meegegeven

Error 400

AdresStraatnaamNietGekendValidatie

De straatnaam 'straatnaamId' is niet gekend in het straatnaamregister.

BR_7

Combinatie positieGeometrieMethode & positieSpecificatie is niet correct

Error 400

AdresPositieSpecificatieValidatie

Ongeldige positieSpecificatie.

BR_14

Het veld positie leeg meegegeven

Error 400

AdresPositieVerplicht

De positie is verplicht.

BR_9

Ongeldig waarde bij positie meegegeven

Error 400

AdresPositieformaatValidatie

De positie is geen geldige gml-puntgeometrie.

BR_9

Postcode ligt niet in de gemeente van het adres

Ticketing error

AdresPostinfoNietInGemeente

De ingevoerde postcode wordt niet gebruikt binnen deze gemeente.

BR_5

Wanneer het huisnummer/busnummer al bestaat

Ticketing error

AdresBestaandeHuisnummerBusnummerCombinatie

Deze combinatie huisnummer-busnummer bestaat reeds voor de opgegeven straatnaam.

BR_11

Adres met busnummer meegeven, maar geen adres met huisnummer aanwezig

Ticketing error

AdresActiefHuisNummerNietGekendValidatie

Er bestaat geen actief adres zonder busnummer (status voorgesteld of inGebruik) voor straatnaam 'straatnaamId' en huisnummer 'huisnummer'.

BR_10

Meegegeven straatnaam heeft status afgekeurd/gehistoreerd

Ticketing error

AdresStraatnaamGehistoreerdOfAfgekeurd

De straatnaam is gehistoreerd of afgekeurd.

BR_7

Meegegeven postinfoId is verschillend tov postinfoId van het adres met huisnummer

Ticketing error

AdresPostinfoNietHetzelfdeAlsHuisnummer

De ingevoerde postcode komt niet overeen met de postcode van het huisnummer.

BR_6

Keur een adres goed

API-documentatie

Wanneer een adres al voorgesteld is in het Adressenregister, kan een decentraal beheerder dit goedkeuren van zodra het:

  • of voorkomt op een goedgekeurd officieel document van de gemeente (bvb. toekenning van een vergunning met voorstel tot adressering).

  • of op het terrein in gebruik is.

In het Adressenregister vertaalt deze goedkeuring zich in een statusaanpassing van voorgesteld naar inGebruik .

BR_15 Een adres kan enkel goedgekeurd worden als het de status voorgesteld heeft.

BR_16 Een adres kan enkel goedgekeurd worden als het niet verwijderd is.

BR_17 Een adres met busnummer kan enkel goedgekeurd worden als het adres zonder busnummer de status inGebruik heeft.

BR_18 Een adres kan enkel goedgekeurd worden als de straatnaam van het adres de status voorgesteld of inGebruik heeft.

BR_19 Bij het goedkeuren van een adres worden de onderliggende busnummers niet automatisch goedgekeurd. Een busnummer kan later goedgekeurd worden dan het huisnummer (bv. bij de oplevering van een appartement).

BR_20 Bij het goedkeuren van een adres moet een geldige adresId meegegeven worden.

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Ongeldig adresId meegegeven

Error 400

/

De waarde 'adresId' is ongeldig.

BR_20

Onbestaand adresId meegegeven

Error 404

/

/

BR_20

Status adresId afgekeurd/gehistoreerd

Ticketing error

AdresAfgekeurdOfGehistoreerd

Deze actie is enkel toegestaan op adressen met status 'voorgesteld'.

BR_15

Adres in straatnaam met status afgekeurd/gehistoreerd

Ticketing error

AdresStraatnaamVoorgesteldOfInGebruik

Deze actie is enkel toegestaan binnen straatnamen met status 'voorgesteld' of 'inGebruik'.

BR_18

Adres is een busnummer & mag niet voorlopen op status adres dat een huisnummer is

Ticketing error

AdresHuisnummerVoorgesteldGehistoreerdOfAfgekeurd

Deze actie is enkel toegestaan op adressen waarbij het huisnummer de status 'inGebruik' heeft.

BR_17

Verwijderd adresId meegegeven

Ticketing error

VerwijderdAdres

Verwijderd adres.

BR_16

Keur een adres af

API-documentatie

Een decentraal beheerder kan een adres dat reeds voorgesteld werd afkeuren in het Adressenregister nog vóór het in gebruik genomen werd of verscheen op een officieel document dat werd goedgekeurd door de gemeente. In het Adressenregister vertaalt een afkeuring zich in een statusaanpassing van voorgesteld naar afgekeurd.

BR_21 Een adres kan enkel afgekeurd worden als het de status voorgesteld heeft.

BR_22 Een adres kan enkel afgekeurd worden als het niet verwijderd is.

BR_23 Een adres met busnummer wordt automatisch mee afgekeurd als het adres zonder busnummer afgekeurd wordt.

BR_24 Bij het afkeuren van een adres moet een geldige adresId meegegeven worden.

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Ongeldig adresId meegegeven

Error 400

/

De waarde 'adresId' is ongeldig.

BR_24

Onbestaand adresId meegegeven

Error 404

/

/

BR_24

Status adresId inGebruik/gehistoreerd

Ticketing error

AdresGehistoreerdOfInGebruik

Deze actie is enkel toegestaan op adressen met status 'voorgesteld'.

BR_21

Verwijderd adresId meegegeven

Ticketing error

VerwijderdAdres

Verwijderd adres.

BR_22

Hef een adres op

API-documentatie

Een decentraal beheerder kan een adres opheffen wanneer dit adres niet langer in gebruik is.

In het Adressenregister vertaalt een opheffing zich in een statusaanpassing van inGebruik naar gehistoreerd.

BR_25 Een adres kan enkel opgeheven worden als het de status inGebruik heeft.

BR_26 Een adres kan enkel opgeheven worden als het niet verwijderd is.

BR_27 Een adres met busnummer in de status inGebruik wordt automatisch mee opgeheven als het adres zonder busnummer opgeheven wordt.

BR_28 Een adres met busnummer in de status voorgesteld wordt automatisch mee afgekeurd als het adres zonder busnummer opgeheven wordt.

BR_29 Bij het opheffen van een adres moet een geldige adresId meegegeven worden.

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Ongeldig adresId meegegeven

Error 400

/

De waarde 'adresId' is ongeldig.

BR_29