Tilbakemeldinger og polling
Følg behandlingen av en melding
Fiks-API-et gjør behandlingsresultatet fra Folkeregisteret tilgjengelig asynkront.
- Ved oppstart: hent
sekvensnummermedGET /api/v1/tilbakemeldinger/start. Valgfri parameterdatokan velge startpunkt. - Kall
GET /api/v1/tilbakemeldinger?fraSekvensnummer=<sekvensnummer>. Parameterenantaller valgfri (standard100, maksimalt1000). - Lagre
nesteSekvensnummerfra responsen og bruk det somfraSekvensnummerved neste kall. Ikke beregn neste verdi selv og ikke kall/startpå nytt for hver runde. - Gjenta med jevne mellomrom og behandle resultatet for hver melding.
Sekvensnumrene for dine tilbakemeldinger er stigende, men kan ha hull.
GET /api/v1/tilbakemeldinger/meldinger/{avsendersMeldingsidentifikator} returnerer siste kjente tilbakemelding for én innsending. Oppslaget gir 404 inntil tilbakemeldingen er tilgjengelig fra Folkeregisteret, selv etter 202 Accepted. Bruk oppslaget når en bruker etterspør svar på en bestemt melding; for normal flyt brukes pollingen over.
Tolk resultatet
status i innsendingens kvittering er Fiks’ MOTTATT; status i tilbakemeldingen tilsvarer Folkeregisterets beslutning. Kontrakten angir GODKJENT, AVSLAATT, AVVIST, AVBRUTT og REGISTRERT; i dag er kun AVVIST og REGISTRERT i bruk.
resultatkode beskriver beslutningen maskinlesbart. Kjente koder (skrivemåten er som oppgitt):
| Operasjon | Registrert/bekreftet | Ikke registrert |
|---|---|---|
| Endre | skalEndre |
skalIkkeEndre |
| Korrigere | skalKorrigere |
skalIkkeKorrigere |
| Opphøre | skalOpphøre |
skalIkkeOpphøre |
| Annullere | skalAnnullere |
SkalIkkeAnnullere |
| Overføre | skalOverføres |
skalIkkeOverføres |
resultatbeskrivelse gir en lesbar forklaring. begrunnelser kan forklare avvisning eller merknad; hver begrunnelse har begrunnelseskode, begrunnelsesnavn og eventuelt begrunnelsesmerknad. Kjente koder:
| Begrunnelseskode | Betydning |
|---|---|
identifikatorForBarnFinnesIkke |
Barnets fødsels- eller d-nummer er ikke tildelt en person |
identifikatorForBarnErIkkeGjeldende |
Opphørt fødsels- eller d-nummer for barn |
ugyldigBarn |
Barnets personstatus er ikke forenlig med fosterforelder |
identifikatorForForelderFinnesIkke |
Fosterforelderens fødsels- eller d-nummer er ikke tildelt en person |
identifikatorForForelderErIkkeGjeldende |
Opphørt fødsels- eller d-nummer for fosterforelder |
ugyldigForelder |
Fosterforelderens personstatus er ikke forenlig med fosterbarn |
vedtaksdatoErFramtidEllerFeil |
Vedtaksdatoen er i fremtiden eller feil |
gjeldendeOmsorgsansvarFinnesAllerede |
endre ble sendt for en allerede aktiv relasjon |
barnetHarFosterforeldre |
Barnet har allerede to gjeldende fosterforeldre |
finnerIkkeOmsorgsansvarSomKanSlettes |
Ingen aktiv relasjon å annullere |
finnerIkkeOmsorgsansvarSomKanEndres |
Ingen aktiv relasjon å korrigere |
gyldighetstidspunktForTidlig |
Gyldighetstidspunktet gjør registreringen historisk |
gyldighetstidspunktForSent |
Fosterforelderansvar kan ikke legges inn i fremtiden |
Eksempel på polling med én registrert og én avvist melding (to ulike innsendinger):
Ingen av kodelistene er uttømmende; håndter ukjente koder.