Hendelser fra Person‑API
Denne siden inneholder en liste over alle hendelsetypene i Person‑API og en kort beskrivelse av hver. Hendelsetypene er hovedsakelig basert på typene vi konsumerer fra Folkeregisteret (FREG), men siden Person‑API også inneholder data fra andre kilder, har vi lagt til noen hendelsetyper som er unike for Person‑API. Når en hendelse er en direkte oversettelse fra FREG, er det en referanse til den tilsvarende hendelsetypen i FREG.
Vi arbeider for å holde siden oppdatert, men dersom du oppdager mangler, ta kontakt på utvikling-persontjenesten@nhn.no
Ordliste
På denne siden bruker vi følgende forkortelser for å gjøre dokumentasjonen mer konsis:
- FREG – Folkeregisteret (National Population Register)
- PREG – Personregisteret. Den eksisterende tjenesten fra NHN som leverer informasjon om norske borgere, og som nå fases ut.
- NIN – Norsk identifikasjonsnummer (fødsels‑ eller D‑nummer). Omfatter både f‑numre og d‑numre.
- AIN – Alternativt identifikasjonsnummer. Et identifikasjonsnummer som opprettes på forespørsel når en person ikke kan identifiseres med et NIN. Alternativ identifikasjonsnummer opprettes av tjenesten Felles Hjelpenummer, som er en del av PREG.
- Entry – Den registrerte oppføringen for en person i Person‑API eller FREG, som inneholder det siste person‑dokumentet.
For en mer omfattende oversikt over oversettelser fra termer brukt i FREG til termer brukt i Person‑API, se translations.
Person‑API har følgende kategorier av hendelser
- Opprettelse av en person
- Endring i personstatus
- Endring i personopplysninger
- Hendelser for alternative identifikasjonsnumre (AIN)
- Korreksjon av en person
Opprettelse av en person
| Hendelsestype | FREG Hendelsestype | Beskrivelse |
|---|---|---|
| PersonIsCreated | PersonErOpprettet | En ny oppføring for en person opprettes. |
| PersonPopulated | En ny oppføring for en person ble opprettet i Person‑API ved den første, hendelsesløse initialiseringen av API‑et, også kjent som «zero day». |
Endring i personstatus
| Hendelsestype | FREG Hendelsestype | Beskrivelse | |
|---|---|---|---|
| PersonIsResident | PersonErBosatt | En person er registrert som norsk bosatt. | |
| PersonIsDeceased | PersonErDoed | En person er registrert som avdød. | |
| PersonIsEmigrated | PersonErUtflyttet | En person er registrert som utflyttet. |
Endring i personopplysninger
| Hendelsestype | FREG‑hendelsestype | Beskrivelse |
|---|---|---|
| PersonIsUpdated | PersonErOppdatert | Data for en person endres av en automatisert jobb i FREG. Person‑API oppdager i tillegg eventuelle endringer i alle informasjons‑elementer i person‑dokumentet og genererer en hendelse for hvert element som har endret seg. |
| ChangeInStatus | EndringIStatus | Data i informasjonselementet Status har endret seg. |
| ChangeInIdentityVerification | EndringIIdentitetsgrunnlag | Data i informasjonselementet IdentityVerification har endret seg. |
| ChangeInForeignPersonIdentificationNumber | EndringIUtenlandskPersonidentifikasjon | Data i informasjonselementet ForeignPersonIdentificationNumber har endret seg. |
| ChangeInImmigrationAuthoritiesIdentificationNumber | EndringIUtlendingsmyndighetenesIdentifikasjonsnummer | Data i informasjonselementet ImmigrationAuthoritiesIdentificationNumber har endret seg. |
| ChangeInIdentificationDocument | EndringILegitimasjonsdokument | Data i informasjonselementet IdentificationDocument har endret seg. |
| ChangeInNorwegianIdentificationNumber | EndringIIdentifikasjonsnummer | Data i informasjonselementet NorwegianIdentificationNumber har endret seg. |
| ChangeInFalseIdentity | EndringIFalskIdentitet | Data i informasjonselementet FalseIdentity har endret seg. |
| ChangeInResiduaryEstateContactInformation | EndringIKontaktopplysningerForDoedsbo | Data i informasjonselementet ResiduaryEstateContactInformation har endret seg. |
| ChangeInSharedResidence | EndringIDeltBosted | Data i informasjonselementet SharedResidence har endret seg. |
| ChangeInBirth | EndringIFoedsel | Data i informasjonselementet Birth har endret seg. |
| ChangeInBirthInNorway | EndringIFoedselINorge | Data i informasjonselementet BirthInNorway har endret seg. |
| ChangeInGender | EndringIKjoenn | Data i informasjonselementet Gender har endret seg. |
| ChangeInFamilyRelation | EndringIFamilierelasjon | Data i informasjonselementet FamilyRelation har endret seg. |
| ChangeInMaritalStatus | EndringISivilstand | Data i informasjonselementet MaritalStatus har endret seg. |
| ChangeInDeath | EndringIDoedsfall | Data i informasjonselementet Death har endret seg. |
| ChangeInName | EndringINavn | Data i informasjonselementet Name har endret seg. |
| ChangeInAddressProtection | EndringIAdressebeskyttelse | Data i informasjonselementet AddressProtection har endret seg. |
| ChangeInResidentialAddress | EndringIBostedsadresse EndringIBostedsadresseVedKommuneregulering |
Data i informasjonselementet ResidentialAddress har endret seg. |
| ChangeInResidentialAddressWithoutRelocation | EndringIBostedsadresseUtenFlytting | Data i informasjonselementet ResidentialAddress har endret seg uten at personen har flyttet. |
| ChangeInPresentAddress | EndringIOppholdsadresse | Data i informasjonselementet PresentAddress har endret seg. |
| ChangeInImmigrationToNorway | EndringIInnflytting | Data i informasjonselementet ImmigrationToNorway har endret seg. |
| ChangeInEmigrationFromNorway | EndringIUtflytting | Data i informasjonselementet EmigrationFromNorway har endret seg. |
| ChangeInUseOfSamiLanguage | EndringIBrukAvSamiskSpraak | Data i informasjonselementet UseOfSamiLanguage har endret seg. |
| ChangeInSamiParliamentElectoralRegistryStatus | EndringISametingetsValgmanntall | Data i informasjonselementet SamiParliamentElectoralRegistryStatus har endret seg. |
| ChangeInContactinformation | EndringIKontaktinformasjon | Data i informasjonselementet Contactinformation har endret seg. |
| ChangeInParentalResponsibility | EndringIForeldreansvar | Data i informasjonselementet ParentalResponsibility har endret seg. |
| ChangeInCitizenship | EndringIStatsborgerskap | Data i informasjonselementet Citizenship har endret seg (og/eller CitizenshipRetention). |
| ChangeInResidency ChangeInResidencePermit |
EndringIOpphold | Data i informasjonselementet ResidencePermit har endret seg. |
| ChangeInResidencyOnSvalbard | EndringIOppholdPaaSvalbard | Data i informasjonselementet StayOnSvalbard har endret seg. |
| ChangeInGuardianship | EndringIVergemaal | Data i informasjonselementet GuardianshipOrFuturePowerOfAttorney har endret seg. |
| ChangeInPostalAddress | EndringIKontaktinformasjon | Data i informasjonselementet PostalAddress har endret seg. |
| ChangeInForeignPostalAddress | EndringIKontaktinformasjon | Data i informasjonselementet ForeignPostalAddress har endret seg. |
| ChangeInLegalAuthority | EndringIRettsligHandleevne | Data i informasjonselementet LegalAuthority har endret seg. |
Hendelser for alternative identifikasjonsnumre (AIN)
Hendelser for personer importert fra Felles Hjelpenummer‑tjenesten i Personregisteret (PREG) holdes adskilt fra hendelser som har opphav i Folkeregisteret (FREG). Hovedgrunnen til dette er at ikke alle konsumenter er interessert i disse hendelsene, så ved å ha separate hendelsetyper for disse personene blir det enklere å filtrere dem bort når man bruker Person‑API‑ens hendelses‑feed.
| Hendelsestype | Beskrivelse |
|---|---|
| CreatedAlternateIdentificationNumber | En ny oppføring i Person‑API opprettes fra et importert alternativt identifikasjonsnummer. |
| UpdatedAlternateIdentificationNumber | Informasjon for en oppføring med et alternativt identifikasjonsnummer blir oppdatert. |
Korreksjon av en person
General korreksjons hendelser
| Hendelsestype | FREG‑hendelsestype | Beskrivelse |
|---|---|---|
| PersonCorrected | Data for en person er korrigert i Person‑API, uten endringer i data i FREG. | |
| PersonIsDiscontinued | PersonErOpphoert | En oppføring for en person er registrert som avbrutt. Oppføringen slettes ikke, men personen kan ikke lenger slås opp ved NIN i Person‑API. |
| PersonIsReactivated | PersonErReaktivert | Reaktiverer en tidligere avbrutt eller avdød person i registeret. |
Merge entries
Når det oppdages to oppføringer i FREG som viser seg å være for samme person, konsolideres informasjonen til én oppføring. Denne oppføringen markeres som “continued”, mens den andre markeres som “discontinued as duplicate.” Identifikasjonsnummeret/nummerne fra den avbrutte oppføringen overføres til den fortsatte oppføringen og lagres som historiske identifikatorer. Ved oppslag på de overførte identifikatorene vil man få persondokumentet for den fortsatte oppføringen. Hendelser blir sendt for både den fortsatte og den avbrutte oppføringen.
| Hendelsestype | FREG‑hendelsestype | Beskrivelse |
|---|---|---|
| PersonIsContinuedAsValidUponMerger | PersonErViderefoertSomGjeldendeVedSammenslaaing | Hendelse sendes for den fortsatte oppføringen når to oppføringer slås sammen. |
| PersonIsDiscontinuedAsDuplicate | PersonErOpphoertSomDublett | Hendelse sendes for den avbrutte oppføringen når to oppføringer slås sammen. |
Split entry
Når en oppføring i FREG viser seg å tilhøre to separate personer, tas noe av informasjonen fra den opprinnelige oppføringen og overføres til en egen, gjenopprettet oppføring. Et historisk identifikasjonsnummer fjernes fra den opprinnelige oppføringen og settes som gyldig identifikator for den gjenopprettede oppføringen. Hendelser sendes for både den opprinnelige og den gjenopprettede oppføringen.
Dette bør være svært sjeldent, men kan forekomme dersom to oppføringer tidligere ble slått sammen fordi man antok de var samme person, og senere viser seg å være to separate personer.
| Hendelsestype | FREG‑hendelsestype | Beskrivelse |
|---|---|---|
| PersonIsChangedBySplitting | PersonErEndretVedSplitting | Hendelse sendes for den opprinnelige oppføringen når den splittes. |
| PersonIsRestoredBySplitting | PersonErGjenopprettetVedSplitting | Hendelse sendes for den gjenopprettede oppføringen når en oppføring splittes i to. |
Annet
| Hendelsestype | FREG‑hendelsestype | Beskrivelse |
|---|---|---|
| ChangeInPerson | EndringIPerson | Undokumentert hendelsestype fra FREG. |
| Unknown | (ingen) | Skal ikke sendes til konsumenter av Person‑API. Hvis denne hendelsen mottas, er den resultatet av en feil og bør rapporteres. |