openapi: 3.0.1 info: title: Medlemskap Medlemskapsunntak description: "#### Tilkobling:\nFor å kunne benytte tjenesten må konsumenten være autorisert i Maskinporten etter avtale med NAV. Scopet på access tokenet fra Maskinporten må være: `nav:medlemskap/v1/medlemskapsunntak`.\n#### Tjenesten: \nTjenesten tillater konsumenter å hente perioder som beskriver unntak fra hovedregelen om personers medlemskap i den norske folketrygden. Avhengig av hvilket endepunkt man bruker gjør man dette ved å spesifisere en naturlig ident (D- eller fødselsnummer), eller den funksjonelle ID'en til et konkret medlemskapsunntak." version: '1.0' servers: - url: https://api.nav.no/medlemskap/v1/medlemskapsunntak paths: /: get: tags: - medlemskapsunntak summary: Henter ut medlemskapsunntak for en spesifikk person. description: Henter ut medlemskapsunntak for en spesifikk person. operationId: hentMedlemskapsunntakIPeriodeUsingGET parameters: - name: type in: query description: Dersom man kun ønsker perioder med en viss type kan man bruke "MED_MEDLEMSKAP" eller "UTEN_MEDLEMSKAP". schema: type: string - name: ekskluderKilder in: query description: Dersom man ikke ønsker å hente perioder uansett kilde kan man spesifisere hvilke man er interessert i her. schema: type: string - name: fraOgMed in: query description: Format - date (as full-date in RFC3339). Definerer startdatoen for vinduet man skal hente perioder for. Kun perioder som er innenfor dette vinduet vil returneres. Datoen er på ISO-8601-format. schema: type: string - name: tilOgMed in: query description: Format - date (as full-date in RFC3339). Definerer sluttdatoen for vinduet man skal hente perioder for. Kun perioder som er innenfor dette vinduet vil returneres. Datoen er på ISO-8601-format. schema: type: string - name: inkluderSporingsinfo in: query description: Hvorvidt man er interessert i å se sporingsinformasjonen som er registrert på periodene som hentes ut. schema: type: boolean default: false - name: statuser in: query description: Dersom man ikke ønsker å hente perioder uansett status kan man spesifisere hvilke man er interessert i her. schema: type: string - name: Authorization in: header description: 'Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av Maskinporten. Verdien må starte med "Bearer ", etterfulgt av tokenet.' required: true schema: type: string - name: Nav-Call-Id in: header description: En identifikator for kallet som kan brukes i debugging dersom en feil skulle oppstå. required: true schema: type: string - name: Nav-Consumer-Id in: header description: Navnet på servicebrukeren til applikasjonen som gjør kallet - for eksempel "hdir". required: true schema: type: string - name: Nav-Personident in: header description: Identen til personen man ønsker å slå opp. Dette kan være en naturlig ident (DNR/FNR). required: true schema: type: string responses: '200': description: OK content: application/json: { } '401': description: Unauthorized content: application/json: { } '403': description: Forbidden content: application/json: { } '404': description: Not Found content: application/json: { } '/{unntakId}': get: tags: - medlemskapsunntak summary: Henter ut informasjon om et spesifikt medlemskapsunntak description: Henter ut informasjon om et spesifikt medlemskapsunntak operationId: hentMedlemskapsunntakUsingGET parameters: - name: unntakId in: path description: Format - int64. Den funksjonelle ID'en til perioden man ønsker å hente. required: true schema: type: integer - name: inkluderSporingsinfo in: query description: Hvorvidt man er interessert i å se sporingsinformasjonen som er registrert på perioden. schema: type: boolean default: false - name: Authorization in: header description: 'Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av Maskinporten. Verdien må starte med "Bearer ", etterfulgt av tokenet.' required: true schema: type: string - name: Nav-Call-Id in: header description: En identifikator for denne kallrekken som kan brukes i debugging dersom en feil skulle oppstå. required: true schema: type: string - name: Nav-Consumer-Id in: header description: Navnet på servicebrukeren til applikasjonen som gjør kallet - for eksempel "hdir". required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Medlemskapsunntak' example: dekning: string fraOgMed: string grunnlag: string helsedel: true ident: string lovvalg: string lovvalgsland: string medlem: true sporingsinformasjon: besluttet: string kilde: string kildedokument: string opprettet: string opprettetAv: string registrert: string sistEndret: string sistEndretAv: string versjon: 0 status: string statusaarsak: string studieinformasjon: delstudie: true soeknadInnvilget: true statsborgerland: string studieland: string tilOgMed: string unntakId: 0 '401': description: Unauthorized content: application/json: { } '403': description: Forbidden content: application/json: { } '404': description: Not Found content: application/json: { } components: schemas: Medlemskapsunntak: title: Medlemskapsunntak required: - fraOgMed - grunnlag - helsedel - ident - lovvalg - medlem - status - tilOgMed - unntakId type: object properties: dekning: type: string description: Dekningsgraden for dette medlemskapsunntaket. fraOgMed: type: string description: 'Startdatoen for perioden til medlemskapsunntaket, på ISO-8601 format.' format: date grunnlag: type: string description: Grunnlaget for dette medlemskapsunntaket. helsedel: type: boolean description: Hvorvidt dekningen for medlemskapsunntaket har en helsedel. ident: type: string description: Den naturlige identen som medlemskapsunntaket er lagret på. lovvalg: type: string description: Lovvalget for dette medlemskapsunntaket. lovvalgsland: type: string description: Landet dette medlemskapsunntaket gjelder for. medlem: type: boolean description: Beskriver hvorvidt dette medlemskapsunntaket handler om et medlemskap i folketrygden eller ikke. sporingsinformasjon: $ref: '#/components/schemas/Sporingsinformasjon' status: type: string description: Sluttdatoen for perioden til medlemskapsunntaket. statusaarsak: type: string description: Dersom statusen på medlemskapsunntaket ikke er gyldig vil dette feltet beskrive hvorfor. studieinformasjon: $ref: '#/components/schemas/Studieinformasjon' tilOgMed: type: string description: 'Sluttdatoen for perioden til medlemskapsunntaket, på ISO-8601 format..' format: date unntakId: type: integer description: Den funksjonelle ID'en til et medlemskapsunntak. format: int64 description: Informasjonen som er tilgjengelig om et medlemskapsunntak. Sporingsinformasjon: title: Sporingsinformasjon required: - kilde - opprettet - opprettetAv - sistEndret - sistEndretAv - versjon type: object properties: besluttet: type: string description: 'Når det ble tatt en beslutning om dette medlemskapsunntaket, på ISO-8601-format.' format: date kilde: type: string description: Hvilket system medlemskapsunntaket kommer fra. kildedokument: type: string description: I hvilken form søknaden om medlemskapsunntak kom til kilden. opprettet: type: string description: 'Når medlemskapsunntaket ble opprettet, på ISO-8601-format.' format: date-time opprettetAv: type: string description: Hvem eller hva som opprettet medlemskapsunntaket. registrert: type: string description: 'Når dette medlemskapsunntaket ble registrert, på ISO-8601-format.' format: date sistEndret: type: string description: 'Når medlemskapsunntaket sist ble endret, på ISO-8601-format.' format: date-time sistEndretAv: type: string description: Hvem eller hva som sist endret medlemskapsunntaket. versjon: type: integer description: Versjonsnummeret på dette medlemskapsunntaket. Dette sier noe om hvor mange ganger unntaket har blitt endret. format: int32 description: Metadata knyttet til medlemskapsunntaket. Studieinformasjon: title: Studieinformasjon required: - delstudie - soeknadInnvilget - statsborgerland type: object properties: delstudie: type: boolean description: Hvorvidt studenten er deltidsstudent. soeknadInnvilget: type: boolean description: Om søknaden om studielån er blitt innvilget av Lånekassen. statsborgerland: type: string description: Hvilket land studenten er statsborger i. studieland: type: string description: Hvilket land studenten studerer i. description: Studieinformasjonen som er registrert på et medlemskapsunntak. MedlemskapsunntakArray: type: array items: $ref: '#/components/schemas/Medlemskapsunntak' securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ] tags: - name: medlemskapsunntak description: ''