Gebruik van de edit-API's: Percelen

Gebruik van de edit-API's: Percelen

Statusovergangen

Opmerking: de levensloop van percelen wordt niet beheerd in het Adressen- en Gebouwenregister, maar dit gebeurt door AAPD (Algemene Administratie van de Patrimoniumdocumentatie). Door een synchronisatieproces is dit ook zichtbaar in het Adressen- en Gebouwenregister.

draw.io Diagram
  • gerealiseerd: Wanneer er een perceel wordt aangemaakt door AAPD, dan wordt het perceel gerealiseerd.

  • gehistoreerd: Wanneer er een perceel wordt verwijderd door AAPD, dan wordt het perceel gehistoreerd.

Business rules en validatieregels endpoints

Overkoepelend

BR_1 Bij het wijzigen van de geometrie van een perceel vanuit het uniek percelenplan worden de adreskoppelingen automatisch mee gecorrigeerd:

  • Er gebeurt een koppeling met een adres als de adrespositie binnen de perceelsgeometrie valt.

    • Dit gebeurt niet als de adrespositiespecificatie ligplaats is.

  • Er gebeurt een ontkoppeling met de adressen die buiten de perceelsgeometrie vallen.

Koppel een adres aan een perceel

API-documentatie

Een decentraal beheerder kan een een koppeling maken tussen een adres en een perceel.

BR_2 Bij het koppelen van een adres aan een perceel is het verplicht een perceelId mee te geven.

BR_3 Een adres kan enkel gekoppeld worden aan een perceel als het perceel de status gerealiseerd heeft.

BR_4 Een adres kan enkel gekoppeld worden aan een perceel als het perceel niet verwijderd is.

BR_5 Bij het koppelen van een adres aan een perceel is het verplicht een adresId mee te geven.

BR_6 Een adres kan enkel gekoppeld worden aan een perceel als het adres de status voorgesteld of inGebruik heeft.

BR_7 Een adres kan enkel gekoppeld worden aan een perceel als het adres bestaat en niet verwijderd is.

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Het veld adresId niet meegegeven of met waarde leeg of null meegegeven

Error 400

JsonInvalid

Json is not valid.

BR_5

Ongeldige waarde bij adresId / verwijderd adresId meegegeven

Error 400

PerceelAdresOngeldig

Ongeldig adresId.

BR_7

AdresId met status afgekeurd/gehistoreerd meegegeven

Error 400

PerceelAdresAfgekeurdOfGehistoreerd

Het adres is afgekeurd of gehistoreerd.

BR_6

Onbestaand perceelId meegegeven

Error 404

/

/

BR_2

Status perceelId gehistoreerd

Ticketing error

PerceelGehistoreerd

Deze actie is enkel toegestaan op percelen met status 'gerealiseerd'.

BR_3

Verwijderd perceelId meegegeven

Ticketing error

VerwijderdPerceel

Verwijderd perceel.

BR_4

Ontkoppel een adres van een perceel

API-documentatie

Een decentraal beheerder kan een adres ontkoppelen van een perceel.

BR_8 Bij het ontkoppelen van een adres van een perceel is het verplicht een adresId mee te geven.

BR_9 Een adres kan enkel ontkoppeld worden van een perceel als het perceel niet verwijderd is.

BR_10 Bij het ontkoppelen van een adres van een perceel is het verplicht een perceelId mee te geven.

BR_11 Een adres kan enkel ontkoppeld worden van een perceel als het adres bestaat en niet verwijderd is.

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Validatie

Soort error

ErrorCode

ErrorMessage

Business rules

Het veld adresId niet meegegeven of met waarde leeg of null meegegeven

Error 400

JsonInvalid

Json is not valid.

BR_8

Ongeldige waarde bij adresId / verwijderd adresId meegegeven

Error 400

PerceelAdresOngeldig

Ongeldig adresId.

BR_11

Onbestaand perceelId meegegeven

Error 404

/

/

BR_10

Verwijderd perceelId meegegeven

Ticketing error

VerwijderdPerceel

Verwijderd perceel.

BR_9