Omsorgsansvar for fosterforeldre

Kort beskrivelse

Send endringer i fosterforeldres omsorgsansvar til Folkeregisteret via Fiks.

API-et er laget for leverandører av fagsystemer til barnevernstjenestene. Fagsystemet kaller en av API-ets operasjoner for å registrere eller endre omsorgsansvar og henter behandlingsresultatet asynkront. Tjenesten er et produsent-API, ikke et API for oppslag i Folkeregisterets persondata.

Status: API-et og kontrakten er under utvikling. Endepunkter, tilgang og tilgjengelighet i test og produksjon må avklares før integrasjon tas i bruk.

Kom i gang

Integrasjonen bruker Fiks integrasjonsinnlogging med Maskinporten. Se felles veiledning for integrasjoner for opprettelse, autentisering og tilgang. TODO: avklare tilgangstyring

Følgende base-URL-er er oppgitt i kontraktsutkastet, ikke bekreftet som tilgjengelige:

TODO: Urler kan endre seg før endelig versjon er ferdig.

Beskrivelse av tjenesten

Overordnet flyt

1. Velg riktig operasjon og kall det tilhørende POST-endepunktet i API-et med JSON-data i forespørselen. Hvert kall gjelder én relasjon mellom fosterbarn og fosterforelder. Se innsending.
2. Fiks kvitterer for mottak med 202 Accepted.
3. Hent startsekvens og poll tilbakemeldinger for å finne ut om meldingen ble registrert eller avvist.

Se brukseksemplene for valg av operasjon i typiske situasjoner.

API-referanse

OpenAPI-kontrakten på GitHub

• Brukseksempler
• Innsending av omsorgsansvar
• Tilbakemeldinger og polling {class=“children children-type-tree children-sort-”}

Få hjelp