REST-tjeneste for full eksport og endringshendelser i AdresseRegisteret

Denne tjenesten er tiltenkt å brukes for å holde en lokal kopi av Adresseregisteret (AR) oppdatert, ved å tilby et endepunkt for å hente ut hele AR, og et endepunkt for å hente ut endringer som har skjedd i AR etter en gitt hendelses-ID eller tidspunkt.

Tjenesten kan brukes som en erstatning for ARProxy.

Eksport

Endepunktet returnerer en full eksport av alle aktive kommunikasjonsparter i AR, samt en hendelses-ID og et tidspunkt for siste oppdateringshendelse. ID-en eller tidspunktet som blir returnert her kan brukes til å spørre etter endringer og oppdateringer som har skjedd etter eksporten ble hentet.

Data blir returnert som JSON med Stream.

Hendelser

Endepunktet returnerer CommunicationParty.Updated og CommunicationParty.Created hendelser. Hver hendelse inneholder en ID og et tidspunkt, samt den oppdaterte eller opprettede kommunikasjonsparten. Når en virksomhet oppdateres inneholder ikke hendelsen de underliggende tjenestene eller personene, men dersom endringen også påvirker disse vil det sendes ut egne hendelser for hver av dem.

ID-en eller tidspunktet kan brukes til å hente nye endringer. Ved å spørre etter en gitt ID eller tidspunkt returneres alle hendelser som har skjedd etter dette, og dermed også alle endrede eller opprettede kommunikasjonsparter. Slik kan man holde en lokal kopi at AR oppdatert.