KLE-REST udstiller emnesystematikken KLE som RESTful web service.
Ophavsret
Anvendelse af KL Emnesystematik og dertil hørende services kræver i alle forhold et skriftligt samtykke. KL forbeholder sig alle rettigheder til den administrative taksonomi og deraf følgende systematik, jvf. Bernerkonventionen og den deraf følgende gældende danske lov om ophavsret. Kontakt KL, Flemming Nielsen, fln@kl.dk for indgåelse af aftale, forud for anvendelse.
Skemaer
Samtlige REST-skemaer, samt tidligere udgaver kan tilgås her:
- Skemaer per februar 2013 Første udgave
- Skemaer per september 2016 Justering til XML 2.0 format
- Skemaer per december 2017 Indførsel af mere konsekvent navngivning samt ensretning af typer
Dokumentation
Her følger en dokumentation af de forskellige funktioner, der er tilgængelige i KLE-REST.
Som udgangspunkt er udgåede elementer IKKE er inkluderet i de returnerede data. Hvis du ønsker at få udgåede elementer med i resultatet, så skal du tilføje parameteren "udgaaede=true" på REST-kaldet. F.eks.
- http://api.kle-online.dk/resources/emne/81.20.00?udgaaede=true (Udgået emne 81.20.00)
- http://api.kle-online.dk/resources/stikord/07.00.01?udgaaede=true (Stikord til udgået emne 17.00.01)
UUID'er er som udgangspunkt kun inkluderet i de fulde udgaver af hhv. emneplan og handlingsfacetter (se nedenfor). Det er dog muligt at få UUID'er inkluderet ved at tilføje parameteren "uuid=true" til url'en. F.eks.
- http://api.kle-online.dk/resources/emne/00.01.00?uuid=true (Emne 00.01.00 med UUID)
Emneplan
Emneplanen er tilgængelig via de tre grundlæggende resourcetyper: Hovedgrupper, grupper og emner.
- http://api.kle-online.dk/resources/hovedgrupper (link)
- http://api.kle-online.dk/resources/grupper (link)
- http://api.kle-online.dk/resources/emner (link)
Ved kald af ovenstående url'er returnerer rest-servicen en "listevisning" af samtlige aktive hovedgrupper, grupper eller emner i den nuværende udgave af KLE. Resultatet bliver leveret som XML.
Listevisningen indeholder kun helt grundlæggende oplysninger om den/det enkelte hovedgruppe, gruppe eller emne.
Detaljevisning
For at returnere samtlige attributter på et KLE-element kan man kalde følgende funktioner med det pågældende elements nummer.
- http://api.kle-online.dk/resources/hovedgruppe/{nummer} (hovedgruppe 00)
- http://api.kle-online.dk/resources/gruppe/{nummer} (gruppe 00.01)
- http://api.kle-online.dk/resources/emne/{nummer} (emne 00.01.00)
Et kald af ovenstående URL'er med et aktivt KLE-nummer returnerer en "detaljevisning" af det enkelte KLE-element. URL-henvisninger til de enkelte elementer står også angivet i ref-attributten i listevisningen.
Detaljevisningen af hovedgrupper og grupper inkluderer også en liste af hhv. grupper og emner, som er inkluderet i hovedgruppen eller gruppen.
Fuld emneplan og alle handlingsfacetter
Det er muligt at få returneret den fulde emneplan i et KLE XML 2.0-lignende format, som dog også inkluderer stikord (hvad KLE XML 2.0 ikke gør).
- http://api.kle-online.dk/resources/kle/emneplan (hele emneplanen i én XML)
- http://api.kle-online.dk/resources/kle/handlingsfacetter (alle handlingsfacetter i én XML)
De komplette udgaver af hhv. emneplan og handlingsfacetter indeholder IKKE udgåede elementer som udgangspunkt. Hvis man vil have udgåede elementer med kan det foregå på én af følgende måder:
Bemærk at download af udgave med udgåede kan tage op til et minut.
Historik
Alle hovedgrupper, grupper og emner har en redigeringshistorik med en dato for oprettelse, seneste rettelse og evt. ugåetdato. Det er muligt at hente denne historik for alle eller udvalgte emner:
Handlingsfacetter
Handlingsfacetterne er tilgængelige via de to grundlæggende resourcetyper: Handlingsfacetkategori og handlingsfacet.
- http://api.kle-online.dk/resources/handlingsfacetkategorier (link)
- http://api.kle-online.dk/resources/handlingsfacetter (link)
Som med elementerne fra emneplanen så indeholder listevisningen af handlingsfacetterne kun de helt grundlæggende oplysninger om den enkelte handlingsfacet.
Detaljevisning
For at returnere samtlige attributter på en handlingsfacet kan man kalde følgende funktioner med den pågældende handlingsfacets nummer.
- http://api.kle-online.dk/resources/handlingsfacetkategori/{nummer} (Handlingsfacetkategori A)
- http://api.kle-online.dk/resources/handlingsfacet/{nummer} (Handlingsfacet A00)
Stikord
Et stikord er en tekststreng, som peger på et KLE-element (hovedgruppe, gruppe, emne eller handlingsfacet), eller på en kombination af en hovedgruppe, gruppe eller emne og en handlingsfacet.
Et stikord kan også være et såkaldt retskildestikord, som er titlen på en given retskilde (f.eks. lov eller bekendtgørelse), som en given gruppe eller et givent emne peger på.
Stikord kan anvendes i søge- og opslagssammenhæng, og kan i REST-interfacet tilgås på basis af enten et hovedgruppenummer, gruppenummer, emnenummer eller handlingsfacetnummer. Det er IKKE muligt at hente samtlige stikord i KLE via et enkelt REST-kald.
Der følgende muligheder for kald af stikordsfunktionen:
- http://api.kle-online.dk/resources/stikord/{hg/g/e-nummer} (Stikord til emne 17.03.09)
- http://api.kle-online.dk/resources/stikord/{hf-nummer} (Stikord til handlingsfacet G01)
Indenrigsministeriets kontoplan
Indenrigsministeriets kontoplan er en del af budget- og regnskabssystem for kommuner, også kaldet den autoriserede kontoplan (læs mere her).
KLE-redaktionen har udarbejdet en BETA XML-opmærket udgave af kontoplanen til brug i KLE-online (se skema).
Der følgende muligheder for kald af kontoplansfunktionen:
- http://api.kle-online.dk/resources/imkontoplan (Hele kontoplanen)
Adgang til at læse kontoplanen kræver login og password, som kan udleveres ved henvendelse til Flemming Nielsen (fln@kl.dk).