Integrasjon mot SvarUt

For utsending av forsendelser via KS-SvarUt benyttes en SOAP basert web-service. Denne servicen mottar forsendelsen og relevante metadata, og besørger videre ekspedering via elektroniske meldingstjenester eller vanlig post.

For å sikre bakoverkompabilitet versjoneres servicen. Når grensesnittet endres deployes en ny versjon slik at eksisterende klienter selv kan velge når de ønsker å ta i bruk ny versjon. Se tabell under for hvilke versjoner som til enhver tid er støttet. Hver versjon dokumenteres separat. Deprecated bør ikke brukes i nye integrasjoner.

Kall mot SvarUt, timer ut hvis de tar mer enn 15 minutter. Derfor kan det være lurt å ha timeout på tilkoblingen som er lenger enn dette. Da får avsender ikke timeout uten at den er initiert av SvarUt. Ellers kan avsender risikere å ikke få forsendelseID på forsendelser som har gått ok.

Versjon WSDL Status Endringer
ForsendelseServiceV1 WSDL Deprecated NA
ForsendelseServiceV2 WSDL Deprecated
  • Støtte for mottakeradresse ihht NOARK5 (inkl. Land)
  • Ny metode for å hente historikk for en spesifikk forsendelse
  • Kun digital levering (dvs. dokumenter som ikke skal til print)
  • Støtte for giroark i forsendelse
  • Ny metode for å sette status lest fra eksternt system
ForsendelseServiceV3 WSDL Deprecated
  • Støtte for lenker i forsendelser
  • Støtte for metadata til bruk i automatisk import service
ForsendelseServiceV4 WSDL Deprecated
  • Støtte for krypterte forsendelser
  • Utvidede metadata til bruk i automatisk import service
  • Støtte forsendelser som krever nivå4-innlogging
ForsendelseServiceV5 WSDL Deprecated
  • Kan fylle ut SvarSendesTil for å gi informasjon om hvem svar på forsendelsen skal sendes til. Dette blir brukt som avsenderadresse på postlagt brev også.
  • Kan spesifisere om dette er et svar på en tidligere forsendelse.
  • Lagt til dokumentType for å si hvilken type forsendelse dette er(blir renamet til forsendelseType i v7)
  • Eksternref en id som kan brukes til å finne forsendelser
ForsendelseServiceV6 WSDL Deprecated
  • Kan legge med svar på forsendelse link, slik at mottaker kan svare på forsendelsen.
  • Søke opp forsendelseid basert på eksternref
ForsendelseServiceV7 WSDL Deprecated
  • dokumentType heter nå forsendelsetype
  • Støtte for difi sin signeringstjeneste. Beskrivelse av Signeringstjeneste
ForsendelseServiceV8 WSDL Stabil
  • dokumentType lagt til på hver fil. Denne er tilgjengelig i Svarinn.
  • Kan hente liste med mottakersystem for et orgnr
  • Kan hente forsendelseTyper som kan brukes i SvarUt
ForsendelseServiceV9 WSDL Stabil
  • Hente ut signeringshistorikk på en forsendelse
  • Dokument har fått ekskluderesFraPrint, da er ikke filen med i print av forsendelsen. Brukes typisk til filer som kun er interesange om forsendelsen lastes ned digitalt. Xml, lyd, video filer osv.
ForsendelsesServiceV10 WSDL Stabil
  • Ny operasjon: retrieveDokumentMetadata. Denne er lagt inn for å kunne hente ut informasjon om bl.a. hvor dokumentet kan lastes ned og eventuelt lenke til signeringsoppdrag.
  • Endret operasjon: setForsendelseLestAvEksterntSystem. Denne er oppdatert til å ta imot objekt av type LestAv.
  • Endret operasjoner: retrieveForsendelsesStatus og retrieveForsendelsesStatuser, begge returnerer nå samme modell-objekt (ForsendelsesStatus). Sistnevnte operasjon har pakket resultatet i en liste.
  • Forsendelsesid og organisasjonsnummer er kapslet inn i egne typer.
  • Modell-objektet StatusResult heter nå ForsendelsesStatus. Gamle ForsendelseStatus heter nå Status og blir returnert som en del av ForsendelsesStatus.
  • Modell-objektet Brevpost er ikke lenger i bruk og er fjernet.
  • Modell-objektet PrintKonfigurasjon heter nå UtskriftsKonfigurasjon.
  • Alle modell-objektene er oppdatert til å bruke camelCase på felt og attributter.
ForsendelsesServiceV11 WSDL Under utvikling
  • EksponertFor, kan gjør forsendelse tilgjengelig for andre enn mottaker. Brukes av edialog for å tilate innsender å laste ned filene.

Rest versjoner av forsendelseService

Det kommer ikke ny funksjonalitet etter v11 av soap servicen. Nye endringer og features vil komme i Rest servicene. Når vi brekker json strukturen vil det komme ny versjon av servicen. Alle implementasjoner må takle json felt som ikke er spesifisert. Det vil komme nye felt og eksisterende ikke obligatoriske felt kan forsvinne.

Versjon Status Endringer
ForsendelsesRestServiceV1 Under utvikling
  • Funksjonaliteten i V11 flyttet til http/json basert api.

Nedlasting av forsendelser direkte til sakssystem

Sakssystemer kan kalle SvarUt for å laste ned forsendelser direkte ved å bruke enten en REST-tjeneste eller en SOAP web-service.

For å sikre bakoverkompabilitet versjoneres servicen. Når grensesnittet endres deployes en ny versjon slik at eksisterende klienter selv kan velge når de ønsker å ta i bruk ny versjon. Se tabell under for hvilke versjoner som til enhver tid er støttet. Hver versjon dokumenteres separat.

Dokumentasjon Status Endringer
MottaksService V1 REST Stabil NA