Vejledning i indberetning af spildevandsplaner via REST API

Temaerne Kloakopland, Mulighed for udtræden, Undersøgelsesområder og (forsyning med håndtering af ) Terrænnært grundvand for Spildevandsplaner skal indberettes til Plandata. Dette kan gøres på flere måde via Plandata’s indberetningsside. En vejledning til dette kan findes her.

Denne vejledning er en vejledning til brug af Plandata REST API som bruges  til at indberette direkte til Plandata uden om Plandatas brugerflade. Denne service er hovedsageligt tiltænkt tredjeparter der ønsker at lave et tilpasset system til kommuner med yderligere funktionalitet funktionalitet der er struktureret anderledes. REST API'et kan bruges på mange forskellige måder og dette skaber en fleksibilitet i hvorvidt systemet blot “uploade planerne” når de er vedtagne eller man ønsker at bruge Plandatas funktioner om forslag og offentliggørelse osv.

Vejledningen gennemgår de forskellige typer af kald og forklarer dem, igennem eksempler som går fra offentliggørelsen og vedtagelsen af en ny spildevandsplan over rettelser til planen igennem tillæg og til sidst til aflysningen af dele af planen og den fulde plan.

Strukturen i en Spildevandsplan

Når en plan skal indberettes består den af to niveauer:

• En hovedplan som rummer de generelle oplysninger om kommunens spildevandsplan eller det tillæg som der indberettes; Dokumentet, link til der hvor planen er blevet offentliggjort, datoer for planens historik.

• De 4 temaer som skal indberettes som indeholder konkrete oplysninger om temaet samt et link til hvilken plan de er en del af. De fire temaer er: Kloakoplande, Mulighed for udtræden, Undersøgelsesområder og Terrænnært Grundvand.

Kladder/offentlige planer

For alle plantyper i Plandata findes der 3 statusser: Forslag, Vedtaget og Aflyst.

For nogle af disse findes der også en Kladde-status: Kladde til forslag og kladde til Vedtaget.

Når plandata laver regler for valideringsregler laves de altid så vidt muligt, så man har mulighed for at gemme planen i kladde uden at følge planen. Kun når det er nødvendigt laves regler så de altid skal følges også i kladde. Det kan f.eks. være at man ikke kan få lov til at gemme tekst i et tal felt. Men i en kladde er det f.eks. muligt ikke have angivet felter som skal angives i vedtaget. Dette gør det muligt at hente og gemme planer fra plandata i stedet for at have en lokal version som indberettes med mellemrum.

For spildevandsplaner er der dog ikke krav om at planer skal offentliggøres hos plandata, men indberettes. Derfor er det muligt indberette planerne bagud i tid og i øvrigt skifte status direkte til vedtaget så længe alle oplysninger er angivet.

For alle plantyper kan der hentes oplysninger om planer som allerede er indberettet.

Der findes to typer endepunkter:

• Det offentlige endepunkt
• hent kald på den specifikke plantype (alle planer inklusive kladder)

Det offentlig endepunkt kan bruges til at hente alle gældende spildevandsplaner:

Planer der ikke er offentlige, altså planer i kladdestatus kan hentes via bl.a.:

Hvis man f.eks. ønsker at gøre sig klar til at vedtage en ny spildevandsplan, kan man lave et kald for at hente alle vedtagne spildevandsplaner, så disse kan aflyses:

Der kan også være flere vedtagne spildevandsplantillæg som hører til den vedtagne spildvandsplan.

Disse kan hentes ved at tjekke på spildevandsplaner der har et :

Her er det måske bedst at tjekke alle i alles statusser så alle tillæg findes.

På den måde kan man få en liste af planid’er som kan bruges til at aflyse den gældende spildevandsplan og tilhørende tillæg.

en alternativ måde til at finde gældende tillæg kan være at hente alle f.eks. kloakoplande og andre underplaner. Her kan spildevandsplanid bruges til at hente Spildevandsplaner og -tillæg som kloakoplandene er tilknyttet. f.eks.:

Eksempel på et svar for et hent-kald med spildevandsplaner (ingen status)

Eksempler på svar for et hent kald med Kloakoplande:

For at lave en ny plane skal planobjektet først oprettes. Planobjekterne oprettes som næsten tomme skaller og opdateres først efterfølgende.

Når objekter skal oprettes bruges kald med denne struktur:

https://indberet.plandata.dk/plandata-api/spkloakopland/opret

Der kan kun medsendes følgende informationer:

{
"plannavn": "Kloakopland 1",
"planstatus": "KLADDE_TIL_FORSLAG",
"kommunekode": 101,
"spildevandsplanId": 1212233
}

Kun for spildevandsplan skal der ikke medsendes spildevandsplanId, da dette er referencen til hvilken spildevandsplan hvad underplantypen er en del af.

At spildevandsplanId’et skal medsendes betyder at Spildevandsplanen (eller Spildevandsplantillægget) skal være oprettet for at kunne oprette de tilhørende Kloakoplande, Mulighed for udtræden, Undersøgelsesområder og Forsyning for Terrænnært grund.

Når planobjektet oprettes sendes et svar som ligner det nedenstående:

{
"plannavn": "En ny plan",
"planId": 12149638,
"plantype": "SPKLOAKOPLAND",
"planstatus": "KLADDE_TIL_FORSLAG",
"kommunekode": 101,
"geometri": null,
"projection": "EPSG:25832",
"aflysningsdato": null,
"opdateringstidspunkt": "2026-04-14T10:54:32.614",
"aktuel": true,
"spildevandsplanId": 12138287,
"eksisterendeKloakKode": null,
"planlagtKloakKode": null,
"startaarKloak": null,
"ikrafttraedelsesaarKloak": null,
"ejerforholdskode": null,
"validering": {
"valideringsstatus": "VALIDERET_FEJL",
"regelsaet": "1.1.1"
}
}

Når dette er gjort kan man gå i gang med at opdatere det relevante planobjekt.

Opdatering af planer sker efter planobjekter er oprettet. En række af felterne kan opdateres og der kan læses mere om hvilke og hvordan under datamodel på Plandatas hjemmeside her

Planer kan opdateres i Kladde-status både i Kladde til Forslag og Kladde til Vedtaget. Der forhindres som hovedregel ikke i at opdaterer i kladde status selvom der forsøges indberettet noget forkert, medmindre det er noget som ikke kan lade sig gøre i systemet. Et eksempel kan være at fjerne eller opdatere SpildevandsplanId. Dette kan ikke fjernes fordi en lang række dele af systemet er bygget op om at relationer som denne ikke ændrer sig fra version til version. Når planen skal rykkes til en offentlig plantype skal den leve op til valideringsregler før den kan komme igennem.

Når en vedtaget plan opdateres forstås dette som en fejlrettelse af det indberettede. det er altså ikke indberetninger ændringer til planen der skal indberettes på en vedtaget plan. opdateringer/indberetninger af vedtagne planer kan kun udføres hvis de følger valideringsreglerne. Dette er for at sikre datakvaliteten af offentligt indberettede planer.

Et kald som opdaterer et kloakopand med planid 12149638

https://indberet.plandata.dk/plandata-api/spkloakopland/opdater/12149638

Eksempel på json-struktur der medsendes når et opland opdateres

{
"plannavn": "Et nt kloakopland",
"geometri": "{\"type\":\"MultiPolygon\",\"coordinates\":[[[[723587.3333333336,6175951.50605744],[723772.9333333336,6175932.30605744],[723728.1333333335,6175573.906057441],[723561.7333333335,6175529.10605744],[723587.3333333336,6175951.50605744]]]]}",
"eksisterendeKloakKode": "FAELLES",
"planlagtKloakKode": "FAELLES",
"startaarKloak": 2020,
"ikrafttraedelsesaarKloak": 2020,
"ejerforholdskode": "OFFENTLIG"
}

Eksempel retursvaret:

{
"plannavn": "Et nt kloakopland",
"planId": 12149638,
"plantype": "SPKLOAKOPLAND",
"planstatus": "KLADDE_TIL_FORSLAG",
"kommunekode": 101,
"geometri": "{\"coordinates\":[[[[723772.93,6175932.3100000005],[723728.13,6175573.91],[723561.73,6175529.11],[723587.33,6175951.51],[723772.93,6175932.3100000005]]]],\"type\":\"MultiPolygon\"}",
"projection": "EPSG:25832",
"aflysningsdato": null,
"opdateringstidspunkt": "2026-04-14T11:26:33.719",
"aktuel": true,
"spildevandsplanId": 12138287,
"eksisterendeKloakKode": "FAELLES",
"planlagtKloakKode": "FAELLES",
"startaarKloak": 2020,
"ikrafttraedelsesaarKloak": 2020,
"ejerforholdskode": "OFFENTLIG",
"validering": {
"valideringsstatus": "VALIDERET_OK",
"regelsaet": "1.1.1"
}
}

indberettede planer, valideres ved et get kald. man angives planens planid og status på planen og får et svar tilbage med valideringsregler der er brudt.

https://indberettest.plandata.dk/plandata-api/spkloakopland/valider/12149638?planstatus=KLADDE_TIL_FORSLAG

Eksempel på retursvar med valideringsregler

{
"besked": "Planen er valideret med en eller flere valideringsfejl",
"fejlType": "VALIDERINGSFEJL",
"fejl": [
{
"felt": "startaarKloak",
"feltSti": "startaarKloak",
"error": "Startår må kun angives, hvis planlagt kloaktype er angivet",
"regel": "KLO8"
},
{
"felt": "ikrafttraedelsesaarKloak",
"feltSti": "ikrafttraedelsesaarKloak",
"error": "Slutår må kun angives, hvis planlagt kloaktype er angivet",
"regel": "KLO8"
}
]
}

Når en plan skal skifte status sker det på hovedplanniveau. En plan skifter således fra Kladde til forslag til forslag til kladde til vedtaget til vedtaget og til sidst aflyst ved at man skifter Hovedplanens status. Når status skifter på hovedplanen skiftes også status på alle underplaner.

https://indberet.plandata.dk/plandata-api/spildevandsplan/skiftStatus/12149638?planstatus=VEDTAGET

Det eneste der skal angives ved statusskift er planid og status der skiftes til. Hvis Valideringsfejl blokerer for statusskifte sendes de valideringsfejl som skal rettes før der kan skiftes status, eller som blokerer for statusskiftet:

{
"besked": "Ikke muligt at skifte status fra KLADDE_TIL_FORSLAG til VEDTAGET for plan med ID 12149638",
"fejlType": "VALIDERINGSFEJL",
"fejl": []
}

I dette eksempel er det ikke muligt at skifte status fordi der ikke må skiftes status fra Kladde til forslag til Vedtaget.Når der skiftes status til kladde til vedtaget opretter det en kladde fra forslaget. Denne kladde kan slettes og man skal derefter oprette den igen ved statusskift hvis dette ønskes.

Kun hvis statusskifte er til aflysning skal der angives et felt, nemlig dato for aflysning.

Det eneste statusskifte der laves på underplaner er til aflysning. Dette skyldes at mindre dele af planen kan blive aflyst ved et tillæg, hvor de nye oplysninger i tillægget nu er gældende. Dette gøres ved at aflyse Kloakoplandet i spildevandsplanen når det nye Kloakopland til spildevandsplantillæget træder i kraft:

https://indberet.plandata.dk/plandata-api/spkloakopland/skiftStatus/12149638?planstatus=AF

Planer kan slettes i kladde status. Dette har lidt forskellig betydning alt efter hvordan det bruges:

• For en kladde der slettes i kladde til forslag slettes planobjektet helt.
• For en kladde der slettes i kladde til vedtaget slettes planen i kladde status men findes stadig i forslagsstatus. Hvis man ønsker at fjerne et forslag der ikke blev vedtaget gøres dette ved at aflyse forslaget (statusskift fra Forslag til Aflyst). Det vil herefter fremgå som “bortfaldet” i plandata.