Transcript Integrasjoner mot SvarUt

Integrasjoner 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 til 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.
Versjon
Dokumentasjon
WSDLStatus
forsendelseServicV1 forsendelseServiceV1WSDL Stabil
Endringer
NA

forsendelseServiceV2forsendelseServiceV2WSDL
Under
utvikling

Støtte for mottakeradresse
ihht NOARK5 (inkl. Land)
Ny metode for å hente
historikk for en spesifikk
forsendelse
ForsendelseServiceV1
Her beskrives funksjonalitet for ForsendelseServiceV1. For å sikre
bakoverkompatibilitet for klientene så vil denne versjonen ikke endres.
WSDL
Tilgang
For å benytte Web servicen må en bruke HTTP Basic autentication med
brukernavn(avsendernavn) og service-passord. Avsender opprettes av KS-SvarUt
administrator/organisasjons administrator og service-passordet genereres av avsender ansvarlig
via konfigurasjon-siden.
Tjenester
Forsendelsesservicet tilbyr følgende funksjonalitet:
sendForsendelse
Hovedtjeneste som sender inn forsendelse til ekspedering av KS-SvarUt. Følgende metadata
inkluderes:
Felt
Beskrivelse
Mottaker
PrivatPerson eller Organisasjon, full adresse må være utfylt, for
sending til Altinn må orgnr/fødselsnr være utfylt.
Validering
Identifikator som identifiserer systemet som gjør web-service
Avgivende system kallet, vil blant annet kunne benyttes for statistikk og feilsøking.
Ikke obligatorisk felt.
Tittel
Tittel på forsendelsen. Tittel blir vist i tittelfeltet på melding til
Altinn, og i listen over innkommende meldinger.
Må være
utfylt
Konteringskode
Kode som beskriver faktureringskonto for forsendelsen. Kan
benyttes for å gruppere meldingsstatistikk gjennom
forvaltningsløsningen, og sendes videre til print-leverandør.
^[a-zA-Z0-9\\]{0,20}$
Konfigurasjon for hvordan dokumentet skal printes,
Printkonfigurasjon
dobbeltsidig, fargeprint, A-Post, B-Post
Rekkefølgen er rekkefølgen de kommer i brevet. Filnavn er for
Liste med pdf filer intern bruk, må være unikt i en forsendelse. Mimetype på være
application/pdf. Kun det som blir støttet nå.
retrieveForsendelseStatus
Henter status for en forsendelse. En forsendelse kan ha en av tilstandene beskrevet under:
Tilstander (normalløp):
Mottatt
Et kall mottatt på forsendelses-service. En id blir tildelt forsendelsen.
Akseptert
Meldingen er validert og forsendelsesfil dannet.
Varslet
Et varsel om forsendelsen er sendt til varslingstjenesten.
Lest
En forsendelse er lest når hele forsendelsesfilen er lastet ned av mottaker.
Sendt print
Forsendelsen er blitt overført til printleverandør.
Printet
Printkvittering mottatt fra printleverandør eller manuell print bekreftet(via webgrensesnitt).
Tilstander (unntak):
Avvist
Forsendelsen er ikke validert pga. manglende/korrupt metadata, eller fordi forsendelsesfil
ikke kunne dannes.
Manuelt håndtert
Forsendelsen er manuelt avsluttet, f.eks. pga en feilsituasjon.
ForsendelseServiceV2 ER UNDER
UTVIKLING. KAN ENDRES UTEN
VARSEL
Her beskrives funksjonalitet for ForsendelseServiceV2. Denne versjonen er under
utvikling og benyttes på egen risiko. Endringer i grensesnittet må påregnes og disse
vil ikke bli varslet.
WSDL
Tilgang
For å benytte Web servicen må en bruke HTTP Basic autentication med
brukernavn(avsendernavn) og service-passord. Avsender opprettes av KS-SvarUt
administrator/organisasjons administrator og service-passordet genereres av avsender ansvarlig
via konfigurasjon-siden.
Tjenester
Forsendelsesservicet tilbyr følgende funksjonalitet:
sendForsendelse
Hovedtjeneste som sender inn forsendelse til ekspedering av KS-SvarUt. Følgende metadata
inkluderes:
Felt
Beskrivelse
Validering
PrivatPerson eller Organisasjon, full adresse må være utfylt,
for sending til Altinn må orgnr/fødselsnr være utfylt. Støtte
for utenlandske adresser.
Mottaker
Navn
Navn på mottaker.
Adresse1
Adresselinje1
Adresse2
Adresselinje2
Adresse3
Adresselinje3
Postnr
Postnummer
Må være utfylt
Poststed
Poststed
Må være utfylt
Fodselsnr
Hvis Privat, må være utfylt for å kunne levere
til altinn.
Orgnr
Hvis organisasjon, må være utfylt for å kunne
Må være utfylt
Felt
Beskrivelse
Validering
levere til altinn.
Identifikator som identifiserer systemet som gjør web-service
Avgivende system kallet, vil blant annet kunne benyttes for statistikk og
feilsøking. Ikke obligatorisk felt.
Tittel
Tittel på forsendelsen. Tittel blir vist i tittelfeltet på melding til
Må være utfylt
Altinn, og i listen over innkommende meldinger.
Konteringskode
Kode som beskriver faktureringskonto for forsendelsen. Kan
^[a-zA-Z0-9\\benyttes for å gruppere meldingsstatistikk gjennom
]{0,20}$
forvaltningsløsningen, og sendes videre til print-leverandør.
Printkonfigurasjon
Konfigurasjon for hvordan dokumentet skal printes,
dobbeltsidig, fargeprint, A-Post, B-Post
Vi leverer kun digitalt, ingen print og postlegging. Hvis
dokumentet ikke kan leveres digital blir det ikke levert. Hvis
KunDigitalLevering
KunDigitalLevering er valgt må fødselsnr eller orgnr være
utfylt.
Rekkefølgen er rekkefølgen de kommer i brevet.
Liste med pdf filer
Filnavn
Filnavn er for intern bruk, må være unikt i en
forsendelse.
Mimetype
Mimetype på være application/pdf. Kun det
som blir støttet nå.
Data
Fildata
Kun
application/pdf
Liste med sidetall som skal printes på gult
GiroarkSider giroark. Digital versjon vil få grått giroark.
Første side er 1.
retrieveForsendelseStatus
Henter status for en forsendelse. En forsendelse kan ha en av tilstandene beskrevet under:
Tilstander (normalløp):
Mottatt
Et kall mottatt på forsendelses-service. En id blir tildelt forsendelsen.
Akseptert
Meldingen er validert og forsendelsesfil dannet.
Varslet
Et varsel om forsendelsen er sendt til varslingstjenesten.
Lest
En forsendelse er lest når hele forsendelsesfilen er lastet ned av mottaker.
Sendt print
Forsendelsen er blitt overført til printleverandør.
Sendt digitalt
Forsendelsen er motatt og sendt slik den skal. Ikke blitt lest enda.
Printet
Printkvittering mottatt fra printleverandør eller manuell print bekreftet(via webgrensesnitt).
Tilstander (unntak):
Avvist
Forsendelsen er ikke validert pga. manglende/korrupt metadata, eller fordi forsendelsesfil
ikke kunne dannes.
Manuelt håndtert
Forsendelsen er manuelt avsluttet, f.eks. pga en feilsituasjon.
retrieveForsendelseHistorikk
Henter historikk for en forsendelse. Returnerer en liste med beskrivelse av hva som har skjedd og
når det inntraff
Felt
Beskrivelse
Validering
Forsendelsesid
Identifikator som unikt identifiserer en forsendelse.
Må være utfylt