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 Validering
Mottaker PrivatPerson eller Organisasjon, for sending til Altinn må orgnr/fødselsnr være utfylt.
Navn Navn på mottaker. Må være utfylt
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 levere til altinn.
Avgivende system Identifikator som identifiserer systemet som gjør web-service kallet, vil blant annet kunne benyttes for statistikk og feilsøking. Bruk følgende for sak/arkivsystemene: Ephorte, ESA, 360 og Websak. For andre fagsystemer avtales dette med KS KommIT på [svarut@ks.no](mailto:svarut@ks.no). 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}$
Printkonfigurasjon Konfigurasjon for hvordan dokumentet skal printes, dobbeltsidig, fargeprint, A-Post, B-Post
Liste med pdf filer Rekkefølgen er rekkefølgen de kommer i brevet. Filnavn er for intern bruk, må være unikt i en forsendelse. Mimetype på være application/pdf. Kun det som blir støttet nå. Total filstørrelse inntil 250MB er støttet.

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.