{"openapi":"3.1.0","info":{"description":"Tjenesten leverer innhold fra rettsinformasjon som Skatteetaten publiserer på sine nettsider, for eksempel innhold i håndbøker.","version":"1.0.0","title":"Rettsinformasjon API","termsOfService":"https://www.skatteetaten.no/deling/bruksvilkar-for-delingstjenester","contact":{"name":"Brukerstøtte","url":"https://www.skatteetaten.no/deling/kontakt/"}},"externalDocs":{"description":"Dokumentasjon på Skatteetatens GitHub","url":"https://skatteetaten.github.io/api-dokumentasjon/api/rettsinformasjon"},"servers":[{"url":"https://rettsinformasjon.api.skatteetaten-test.no/v1","description":"Ekstern test"},{"url":"https://rettsinformasjon.api.skatteetaten.no/v1","description":"Produksjon"}],"security":[{"maskinporten":["skatteetaten:rettsinformasjon"]}],"components":{"securitySchemes":{"maskinporten":{"type":"http","description":"Maskinporten benyttes for autentisering","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Feil":{"description":"Feilstruktur for alle feilmeldinger.","type":"object","properties":{"kode":{"type":"string","description":"Feilkode, for maskinell håndtering","example":"RET-0xx"},"melding":{"type":"string","description":"Beskrivelse av feilen som har oppstått","example":"Oppgitt rettighetspakke er ugyldig."},"korrelasjonsid":{"type":"string","description":"Korrelasjonsid","example":"123e4567-e89b-12d3-a456-426655440000"}}},"Haandbok":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/72a7fed8-d43a-4275-81fb-38628903657c'>Begrepsreferanse</a>)","properties":{"identifikator":{"description":"Identifikator som skal brukes til å identifisere en spesifikk publikasjon.","$ref":"#/components/schemas/Tekst"},"tittel":{"description":"Tittel på publikasjonen, feks. Merverdiavgiftshåndboken.","$ref":"#/components/schemas/Tekst"}}},"Rettsinformasjon":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/27db5515-4bff-4f50-8683-bf4d2ba0bbba'>Begrepsreferanse</a>)","properties":{"tittel":{"description":"Tittel på publikasjonen, feks. Merverdiavgiftshåndboken.","$ref":"#/components/schemas/Tekst"},"identifikator":{"description":"Identifikator som skal brukes til å identifisere en spesifikk publikasjon.","$ref":"#/components/schemas/Tekst"},"typeRettsinformasjon":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/27db5515-4bff-4f50-8683-bf4d2ba0bbba'>Begrepsreferanse</a>)","$ref":"#/components/schemas/TypeRettsinformasjon"},"lovseksjon":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/53bd70e5-8e95-4e4b-b387-3e5d9c1b8b8c'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Notat"},"endringskommentar":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/0b0696d3-a4d0-4b3c-affb-4a24533b6daf'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Notat"},"publiseringsdato":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/1fcae0e4-849e-426a-ad8f-8b71bb74162a'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"gjelderFraDato":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/ae2a5f8a-692a-4f9b-9a2f-6f94b61b996b'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"opphevetDato":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/59dc8815-f64f-4836-9d40-4a60480a4a4e'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"innholdseksjoner":{"type":"array","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/df82fd54-7424-42e1-b447-8ef02a531a35'>Begrepsreferanse</a>)","items":{"$ref":"#/components/schemas/Innholdseksjoner"}}}},"Haandboeker":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/72a7fed8-d43a-4275-81fb-38628903657c'>Begrepsreferanse</a>)","properties":{"haandboeker":{"type":"array","description":"Liste av tilgjengelige håndbøker.","items":{"$ref":"#/components/schemas/Haandbok"}}}},"Innholdseksjoner":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/df82fd54-7424-42e1-b447-8ef02a531a35'>Begrepsreferanse</a>)","properties":{"identifikator":{"description":"Identifikator som skal brukes til å identifisere en spesifikk innnholdseksjon.","$ref":"#/components/schemas/Tekst"},"overskrift":{"description":"Overskrift på innholdseksjonen.","$ref":"#/components/schemas/Tekst"}}},"Innholdseksjon":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/df82fd54-7424-42e1-b447-8ef02a531a35'>Begrepsreferanse</a>)","properties":{"typeInnholdseksjon":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/df82fd54-7424-42e1-b447-8ef02a531a35'>Begrepsreferanse</a>)","$ref":"#/components/schemas/TypeInnholdseksjon"},"identifikator":{"description":"Identifikator som skal brukes til å identifisere en spesifikk innnholdseksjon.","$ref":"#/components/schemas/Tekst"},"overskrift":{"description":"Overskrift på innholdseksjonen.","$ref":"#/components/schemas/Tekst"},"tekst":{"description":"Fritekstfelt som brukes til å beskrive innholdet i rettsinformasjonen.","$ref":"#/components/schemas/Notat"},"publiseringsdato":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/1fcae0e4-849e-426a-ad8f-8b71bb74162a'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"gjelderFraDato":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/ae2a5f8a-692a-4f9b-9a2f-6f94b61b996b'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"opphevetDato":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/59dc8815-f64f-4836-9d40-4a60480a4a4e'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"endringskommentar":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/0b0696d3-a4d0-4b3c-affb-4a24533b6daf'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Notat"},"forskrifter":{"description":"Tekstboks som inneholder opplisting av relevante forskrifter.","$ref":"#/components/schemas/Notat"},"regelverk":{"description":"Tekstboks som inneholder relevant bestemmelse.","$ref":"#/components/schemas/Notat"},"forarbeider":{"description":"Tekstboks som inneholder opplisting av relevante forarbeider.","$ref":"#/components/schemas/Notat"},"innholdseksjoner":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Innholdseksjon"}}}},"Notat":{"type":"string","description":"vilkårlig lang sekvens av tegn inkludert aksenter og spesielle tegn fra standardiserte tegnsett (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b52af3-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)"},"Tekst":{"type":"string","description":"vilkårlig lang sekvens av tegn inkludert aksenter og spesielle tegn fra standardiserte tegnsett (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b52af3-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","maxLength":4000},"Dato":{"type":"string","description":"gir verdier for år, måned og dag. Kodes som en tekststreng etter datoformatering spesifisert i  ISO 8601 (ISO 8601:2004 Data elements and interchange formats -- Information interchange -- Representation of dates and times). Eksempel : 1998-12-21 eller 19981221. (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b52aed-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"date"},"TypeRettsinformasjon":{"type":"string","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/kodeliste/738af478-00bf-45c1-96b1-682316fbb574'>Kodelistereferanse</a>) (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/27db5515-4bff-4f50-8683-bf4d2ba0bbba'>Begrepsreferanse</a>)"},"TypeInnholdseksjon":{"type":"string","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/kodeliste/c26a13f2-4238-4625-95b9-cd258868b7ea'>Kodelistereferanse</a>) (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/df82fd54-7424-42e1-b447-8ef02a531a35'>Begrepsreferanse</a>)"}},"parameters":{"rettighetspakke":{"name":"rettighetspakke","in":"path","description":"Datakonsumenter plasseres i en rettighetspakke (per datasett) basert på en juridisk vurdering. Rettighetspakken styrer skjermingsregler, filtrering og detaljering som benyttes når det gis innsyn i data i datasett.","required":true,"schema":{"type":"string"}},"haandbokIdentifikator":{"name":"haandbokIdentifikator","in":"path","description":"Identifikator for håndbok. Identifikatoren kan finnes ved å hente ut alle tilgjengelige håndbøker via GET /{rettighetspakke}/haandboeker","required":true,"schema":{"type":"string","example":"folkeregisterhandboken"}},"korrelasjonsid":{"name":"korrelasjonsid","in":"header","description":"Unik identifikator for den tekniske forespørselen. Må være på UUID-format","required":false,"schema":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426655440000"}}}},"paths":{"/{rettighetspakke}/haandboeker":{"get":{"summary":"Hent oversikt over tilgjengelige håndbøker","description":"Hent oversikt over identifikatorer til tilgjengelige håndbøker","operationId":"HentHaandboeker","tags":["Rettsinformasjon"],"parameters":[{"$ref":"#/components/parameters/rettighetspakke"},{"$ref":"#/components/parameters/korrelasjonsid"}],"responses":{"200":{"description":"Gyldig respons","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Haandboeker"}}}},"default":{"description":"Alle feil fra applikasjonen kommer på følgende format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}},"/{rettighetspakke}/haandboeker/{haandbokIdentifikator}/rettsinformasjon":{"get":{"summary":"Hent rettsinformasjon for håndbok med angitt identifikator","description":"Hent rettsinformasjon for håndbok med angitt identifikator. Rettsinformasjonen inneholder blant annet en oversikt over kapitler i håndboken.","operationId":"HentRettsinformasjon","tags":["Rettsinformasjon"],"parameters":[{"$ref":"#/components/parameters/rettighetspakke"},{"$ref":"#/components/parameters/haandbokIdentifikator"},{"$ref":"#/components/parameters/korrelasjonsid"}],"responses":{"200":{"description":"Gyldig respons","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rettsinformasjon"}}}},"default":{"description":"Alle feil fra applikasjonen kommer på følgende format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}},"/{rettighetspakke}/haandboeker/{haandbokIdentifikator}/innholdseksjoner/{innholdseksjonIdentifikator}":{"get":{"summary":"Hent innholdseksjon for en håndbok","description":"Hent en spesifikk innholdseksjon i en håndbok. Innholdseksjonen inneholder blant annet tekst, regelverk, forskrifter og eventuelle underliggende innholdseksjoner.","operationId":"HentInnholdseksjon","tags":["Rettsinformasjon"],"parameters":[{"$ref":"#/components/parameters/rettighetspakke"},{"$ref":"#/components/parameters/haandbokIdentifikator"},{"name":"innholdseksjonIdentifikator","in":"path","description":"Identifikator for innholdseksjon i en håndbok. Identifikatoren kan finnes ved å hente ut rettsinformasjon for en gitt håndbok via GET /{rettighetspakke}/haandboeker/{haandbokIdentifikator}/rettsinformasjon","required":true,"schema":{"type":"string","example":"FRH_ID-1-0.001"}},{"$ref":"#/components/parameters/korrelasjonsid"}],"responses":{"200":{"description":"Gyldig respons","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Innholdseksjon"}}}},"default":{"description":"Alle feil fra applikasjonen kommer på følgende format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}}}}