Uttrekk

Grensesnittbeskrivelse

Uttrekktjenesten gir tilgang til å hente ut et utvalg med personer basert på én eller flere kriterier, som for eksempel sekvensnummer, fødselsår, gatenavn, og kommune. Tjenestene er delt i 3 deler som utføres i rekkefølge:

1. Bruk uttrekk/komplet eller uttrekk/tilpasset for å bestille ett uttrekk
2. Bruk uttrekk/hent samme med et batchnummer for å hente resultatet av uttrekket. Resultatet er enten fødsel- eller d-nummer (fra tilpasset uttrekk) eller dokumentID (fra komplett uttrekk)
3. Bruk bulkoppslag for å hente personinformasjon

Merk at JobbID returneres umiddelbart, men batchen er ikke nødvendigvis ferdig umiddelbart. Feilmelding 404 indikerer at jobbID ikke er ferdig. Det anbefales å bygge inn en retry-mekanisme med en delay mellom hvert forsøk.

Første batch har nummer 0, Komplett uttrekk og tilpasset uttrekk deler batcher i et gitt antall. Den siste batchen vil returnere svaret {}. Dette indikerer at det ikke er flere treff å hente.

Følgende algoritme beskriver flyten for de tre tjenestene:

  jobbid = bestillUttrekk(sekvensnummer)
    
      batchteller = 0
      batch = hentResultat(jobbid, batchteller)
    
      while (batch.resultat > 0) {
        persondokumenter = hentPersondokumenter(batch)
        // behandle persondokumenter
    
        batch = hentResultat(jobbid, ++batchteller)
      }
    

Komplett uttrekk

Hensikten med tjenesten er å tillate konsumenter å hente ned hele registeret fra et gitt tidspunkt. Tidspunktet er representert med et sekvensnummer. Alle persondokumentene som er gyldig ved sekvensnummeret, samt alle etterfølgende endringer vil returneres. Tjenesten vil aldri benyttes til daglig vedlikehold av et register, men vil være nyttig i forholdelse med innlasting av en initiell befolkning.

Tilpasset uttrekk

Hensikten med denne POST-tjenesten er å tillate søk på grupper av personer. Hvilke rettighetspakker som tjenesten er tilgjengelig for er beskrevet her.

tabellen under beskriver hvilke muligheter for tilpassing av uttrekket som støttes.

Endepunkter

For oppbygging av endepunkter se her.