/
Metode DigitaltAktivOmraadeliste (erstattes av ny funksjon)

Metode DigitaltAktivOmraadeliste (erstattes av ny funksjon)

API-navn

DigitaltAktiv

Metode/funksjon

DigitaltAktivOmraadeliste - Erstattet av HelsenorgeAktivSjekken

Endepunkt

https://{BaseUrl)/digitaltaktiv/v1/DigitaltAktivOmraadeliste

Funksjonelt område

Digitalt aktiv

API-versjon og dato publisert

v1 Apr 20, 2022

Status

I Drift Avvikles

API-dokumentasjon sist endret

Jul 4, 2022

Teknologi

REST

Metodens formål

NB! Denne metoden skal ikke tas i bruk av nye integrasjoner, og eksisterende bruk bør erstattes av: HelsenorgeAktivSjekken

Metoden kan brukes av eksterne aktører for å undersøke om en liste med innbyggere er aktive på Helsenorge eller ikke. Basert på svaret, kan det eksterne systemet vurdere om det kan og bør kommunisere med innbyggerne via Helsenorge og/eller om det må benytte alternative kanaler. Metoden kan benyttes dersom man ønsker å lagre innbyggers digitale status i eget system.

Detaljert dokumentasjon av metoden

Autentisering og autorisasjon

Alle API’er krever at klienten på forhånd har autentisert seg mot vår Sikkerhetstjeneste og fått utstedt et aksesstoken som skal være med i tjenestekallene til det enkelte API. DigitalAktiv tjenesten krever ikke at kallet utføres i context av en innlogget bruker dvs. UseCase 1 (system-til-system) beskrevet her kan benyttes: 01 - System til System

HTTP verb

Det skal benyttes POST og alltid https.

For å unngå at innbyggers fødselsnummer er en del av parameterne i URL’en, og dermed vil vises i browser-historikk, benyttes alltid POST med parametere i requestens body.

Request

Plassering

Navn

Type

Beskrivelse

Plassering

Navn

Type

Beskrivelse