Öppna data – API-tjänst för Ändamålskatalogen

API-tjänsten innehåller ändamål för byggnadsdelar med tillhörande vägledning. Indelningen av ändamål och vägledningen syftar främst till att utgöra underlag till värdelista för Nationella specifikationer och Nationella geodataplattformen inom den nationella specifikationen för Byggnad.

Informationen i tjänsten

Tjänsten tillhandahåller Ändamålskatalogen som innehåller ändamål med tillhörande vägledningstexter, bilder och referenser. Tjänsten innehåller även metadata om ändamålen i form av bland annat giltighetstid och versionshantering. Ändamål som beskrivs i tjänsten ska jämställas med ”ändamål” i den nationella specifikationen för Byggnad.

Informationen som finns i tjänsten levereras via ett publikt tillgängligt API. För mer information om hur API kan konsumeras och vilka villkor som gäller se mer under rubriken ” Villkor” och ”Ansluta till tjänsten”.

API för Ändamålskatalogen

Ändamålskatalogens syfte

Syftet med Ändamålskatalogen är att byggnadsdelars ändamål ska klassas på ett enhetligt sätt i en digital miljö. Katalogen ger även förutsättningar för att samma begrepp på en byggnadsdel används genom hela samhällsbyggnadsprocessen. Katalogen syftar framför allt till att tillhandahålla en aktuell värdelista för den nationella specifikationen för Byggnad.

Ändamålskatalogens innehåll, struktur och uppbyggnad

Ändamålskatalogen är uppbyggd i tre nivåer där övergripande nivåer bryts ner i mer detaljerade nivåer. Detta för att skapa en tydlig struktur. Huvudkategorin, nivå 1, delas in i ändamålen bostad, samhällsfunktion, verksamhet, industri, lantbruk och liknande näring samt övriga byggnadsverk. I den underliggande nivån, nivå 2, delas sedan respektive huvudkategori in i delar. Till exempel delas huvudkategorin bostad upp i småhus, flerbostadshus, specialbostad och bostadskomplement. Därefter följer nivå 3, där det mest detaljerade ändamålet anges. Småhus delas till exempel upp i friliggande enbostadshus, kedjehus, parhus, radhus med mera. Totalt innehåller katalogen ungefär 165 ändamål.

Ändamålen i Ändamålskatalogen är inte en uttömmande lista över alla ändamål som en byggnadsdel kan ha. De ändamål som finns i Ändamålskatalogen är identifierade som nationellt viktiga. I de fall en byggnadsdel har ett ändamål som inte finns med i Ändamålskatalogen finns ändamålet ”okänd”. Ändamålet ”okänd” finns även som underkategorier till nivå 1 och nivå 2.

De två övergripande nivåerna innehåller vägledningstexter för byggnadsdelars användning och i vissa fall även karaktär. I den tredje och mest detaljerade nivån ingår alltid karaktärsbeskrivningen. Dessa kan användas fritt i exempelvis handledningssyfte eller hjälptexter.

Tekniskt sett är hierarkin synlig för konsumenten genom att de övre nivåerna finns refererade vid en fråga som ställs på en lägre nivå.

Innehållet görs tillgängligt i JSON och JSKOS format. Bilder tillgängliggörs som BASE64.

Boverket har även en egen e-tjänst där Ändamålskatalogen tillgängliggörs.

Ändamålskatalogen (e-tjänst)

Samverkan med Nationella Specifikationer

Ändamålskatalogen är dynamiskt länkad till Nationella geodataplattformen. Ändamålen som anges i Ändamålskatalogen valideras då en producent lägger till eller uppdaterar information om ett byggnadsobjekt. Ändamålskatalogen utgör därför den giltiga värdelista som producenter till Nationella geodataplattformen ska användas för att bestämma ”ändamål” mot den nationella specifikationen för Byggnad.

Du kan läsa mer om Nationella geodataplattform och Nationella specifikationer på lantmäteriets webbplats.

Nationella geodataplattformen (på Lantmäteriet webbplats)

Nationella specifikationer (på Lantmäteriet webbplats)

Villkor

Genom att använda API-tjänsten bekräftar du att du har läst, förstått och godkänt användarvillkoren som gäller för tjänsten. Boverket friskriver sig från ansvar för all form av skada som kan uppkomma vid användningen av denna katalog.

Användarvillkor för API-tjänsten framgår av dokumentet ”Användarvillkor och teknisk beskrivning för Ändamålskatalogen” i ”Relaterad information”.

Ansluta till tjänsten

API-tjänsten för Ändamålskatalogen är en REST-API webbtjänst, vilket betyder att den använder sig av https-protokollet för att ta emot och returnera data. För att kommunicera med tjänsten används http-metoder.

Den tekniska beskrivningen för API-tjänsten framgår av dokumentet ”Användarvillkor och teknisk beskrivning för Ändamålskatalogen” i ”Relaterad information”. API-gränssnittet finns tillgängligt via Boverkets utvecklarportal som du också når via ”Relaterad information”.