Hopp til hovedinnhold

Hvordan hente meldinger gjennom Dialogporten

Her er de generelle stegene som typisk utføres for å hente ut lister med dialoger som representerer innholdet du leter etter. Flyten er den samme uansett om det er meldinger eller skjema du leter etter.

Listen med aktører («parties») er alle fysiske og juridiske personer den autentiserte brukeren kan representere.

Dette er nødvendig for å kunne gjøre søk filtrert på aktør i neste trinn (trinn 3).

Hvordan søke etter dialoger:

  • Må oppgis: aktør(er) eller ressurs(er) som indikerer tjenestene.
  • Kan begrense på tidsspenn for opprettelse/endring, og sortere på tidskolonner.
  • Filtrer på tjenesteeier, status, ekstern referanse
  • Fritekstsøk på de felter som Dialogporten
  • Paginert, inntil 1000 dialoger per kall
  • Returnerer en liste med dialog-utdrag
    • Dialog-ID, aktør, ressurs, tittel, oppsummering, status

Hvordan hente dialog for innholdet du vil ha?

  • Dette krever at dialog-ID oppgis (kan hentes fra søk i trinn 3, eller kan komme fra en event)
  • Detaljer om dialogen (handlinger, forsendelser, dokumentvedlegg, aktivitetslogg) er kun tilgjengelig i endepunktet for å hente én dialog.
  • Dialogporten foretar full autorisasjon, merker/omskriver handlinger og forsendelser som ikke er tilgjengelig
  • Innholdsdata (vedlegg etc.) ligger som eksterne lenker som sluttbrukersystemet må følge.

Under API-actions finnes de ulike operasjonene som sluttbrukersystem kan utføre, for eksempel hente meldingsinnhold, bekrefte den som har lest, slette etc.

Sluttbrukersystem følger en navngitt lenke for å hente meldingsinnhold og oppgir token med «altinn:correspondence.read»-scope.

  • Polling gjennom søke-API er mulig, men vil begrenses gjennom rate-limiting
  • Abonner på hendelser gjennom Altinn Events (Varsling)
    • Oppgi endepunkt for mottak av CloudEvent med filtre
      • For ressurs/tjeneste (påkrevd)
      • Aktør (organisasjonsnummer/fødselsnummer (valgfritt)
      • Hendelsestype (opprettet/endret/etc. Valgfritt)
  • Events vil pushe (med retry) hendelser som abonnenten er autorisert for.

Her finner du API-spesifikasjon for Altinn Events.

Bilde som viser hvordan Dialogporten henter meldinger