OneDoor API'er

Denne side beskriver centrale APIer, der kan benyttes til integration af OneDoor i egne systemer samt hente metadata om OneDoor installationen. Listen er ikke fuldt dækkende så hvis der er noget du mangler så sig til

Beskrivelse af installationen

Topniveauet viser, hvilke organisationer og konfigurationer der findes i Onedoor installationen.

Eksempel:

https://onedoor.demo.septima.dk/api/v1/description

Dette endpoint kan benyttes som udgangspunkt, når man vil se, hvilke organisationer og konfigurationer der er i din OneDoor installation.

Datakilder og typer

Endpointet sources viser, hvilke datakilder der findes for en given organisation og konfiguration, samt hvilke typer der er tilgængelige under hver datakilde.

Eksempelvis har datakilden Dawa flere typer, såsom:

• veje
• adresse
• husnummer

Eksempel for organisationen septima og konfigurationen 01-plus:

https://onedoor.demo.septima.dk/api/v1/organisations/septima/configurations/01-plus/sources

Dette endpoint benyttes til at få overblik over, hvilke datakilder og datatyper der kan søges i.

Søgning i en datakilde

Der kan søges i en bestemt source og type ved at angive en søgetekst med parameteren q.

I eksemplet nedenfor søges der i:

• source: plansystem
• type: vedtagetlokalplan
• søgetekst: skanderborg

https://onedoor.demo.septima.dk/api/v1/organisations/septima/configurations/01-plus/sources/plansystem/types/vedtagetlokalplan?q=skanderborg

Svaret indeholder søgeresultater samt information om, hvilke detaljer — for eksempel faner — der er tilgængelige for de enkelte resultater.

Opslag direkte med id

Hvis id'et på et konkret resultat kendes, kan man slå resultatet direkte op.

Eksempel på direkte opslag af en vedtaget lokalplan:

https://onedoor.demo.septima.dk/api/v1/organisations/septima/configurations/01-plus/sources/plansystem/types/vedtagetlokalplan/1331143

Dette endpoint brbenyttesuges, når man vil hente et bestemt objekt uden først at lave en fritekstsøgning.

Konfliktsøgning med geometri

En geometri i WKT-format kan benyttes til generisk konfliktsøgning. Resultatet viser både de objekter, der overlapper geometrien, og hvilke detaljer der er konfigureret.

Eksempel med polygon:

https://onedoor.demo.septima.dk/api/v1/organisations/septima/configurations/01-plus/sources/Geometries/types/Geometry/POLYGON((558520.8124220815%206212012.6764148455,558528.7237665668%206211946.453963047,558594.3780320341%206211942.45113815,558590.7014615693%206212029.455797674,558520.8124220815%206212012.6764148455))

Svaret viser også de tilgængelige detaljer, eksempelvis faner, som kan hentes for resultatet.

Detaljer for et resultat

Når et søgeresultat eller opslag indeholder detaljer, kan de enkelte detaljer hentes fra endpointet details.

I eksemplet nedenfor er der fundet en lokalplan med en detail/fane med navnet ejere.

Metadata for denne detail er:

Denne fane viser ejere, der overlapper geometrien fra resultatet.

Eksempel:

https://onedoor.demo.septima.dk/api/v1/organisations/septima/configurations/01-plus/sources/plansystem/types/vedtagetlokalplan/2455965/details/ejere

Dette endpoint bruges til at hente indholdet af en bestemt detail/fane for et konkret resultat.