ForsendelseServiceV5 Her beskrives funksjonalitet for ForsendelseServiceV5 WSDL (../tjenester/forsendelseservice/forsendelsesservicev5? wsdl) Tilgang For å benytte webservicen 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 (/konfigurasjon/) siden. Tjenester Forsendelsesservicet tilbyr følgende funksjonalitet: sendforsendelse Hovedtjeneste som sender inn forsendelse til ekspedering av KS SvarUt. Følgende metadata inkluderes: Mottaker 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. Navn Navn på mottaker. Må være utfylt Adresse1 Adresse2 Adresse3 Adresselinje1 Adresselinje2 Adresselinje3 Postnr Postnummer Må være utfylt Poststed Poststed Må være utfylt Land Fødselsnr Orgnr Land Hvis Privat, må være utfylt for å kunne levere til altinn. Hvis organisasjon, må være utfylt for å kunne levere til altinn. https://svarut.ks.no/dokumentasjon/servicev5.html 1/5
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. Konteringskode Printkonfigurasjon KunDigitalLevering kryptert på forsendelsen. blir vist i tittelfeltet på melding til Altinn, og i listen over innkommende meldinger. Kode som beskriver faktureringskonto for forsendelsen. Kan benyttes for å gruppere meldingsstatistikk gjennom forvaltningsløsningen, og sendes videre til print leverandør. 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 er valgt må fødselsnr eller orgnr være utfylt. Settes til true dersom fil(ene) som sendes er kryptert. Dersom kryptering ikke er brukt må denne være satt til false. Se kodeeksempler for eksempel på kryptering. Det må være kryptert med CMS med svarut sin publickey. Den offentlige nøkkelen (/forsendelse/publickey/hent) Må være utfylt ^[a za Z0 9\ \.øæåøæå] {0,20}$ krevniva4innlogging Forsendelsen krever nivå 4 innlogging for å kunne lastes ned. Disse forsendelsene må være kryptert. Liste med pdf filer Rekkefølgen er rekkefølgen de kommer i brevet. Total filstørrelse inntil 250MB er støttet. Filnavn Mimetype Data Filnavn er for intern bruk, må være unikt i en forsendelse. Mimetype på være application/pdf hvis den skal til print. Kun digital levering er valgt kan vi ta imot annet. Fildata Kun application/pdf hvis den skal til print GiroarkSider Liste med sidetall som skal printes på https://svarut.ks.no/dokumentasjon/servicev5.html 2/5
gult giroark. Digital versjon vil få grått giroark. Første side er 1. Liste med Lenker Rekkefølgen er samme som de vil komme i brevet. Kan være tom. Url lenke Url tekst Ledetekst Selve lenken til dokument/nettside Mimetype på være application/pdf. Kun det som blir støttet nå. Teksten som kommer før lenken i brevet Må være utfylt og være i gyldig lenke format, altså (http/https/ftp)://(nettside). (com/no/ etc) Må være utfylt Metadata fra avleverende system Noark5 metadata fra avleverende system, foreløbig oversikt Saksekvensnummer Saksaar Journalaar Journalseksvensnummer Journalpostnummer Journalposttype Journalstatus Journaldato DokumentetsDato Saksbehandler EkstraMetadata Liste med key,value for forskjellige behov. Keys må være unique. Metadata i mottakende system Noark5 metadata som stemmer med mottakende system. Kan brukes til å legge dokumentet på rett sak. Samme som over. Saksekvensnummer https://svarut.ks.no/dokumentasjon/servicev5.html 3/5
Saksaar Journalposttype Journalstatus DokumentetsDato 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. Forsendelser med denne status vil kun leveres digitalt, og vil aldri gå til print. Sendt SDP Forsendelsen er motatt og sendt til Sikker digital postkasse. Levert SDP Forsendelsen er motatt og sendt til Sikker digital postkasse. Vi har motatt Leveringskvittering fra SDP. Forsendelsen skal da være tilgjengelig for mottaker. 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. retrieveforsendelsestatuser Henter status for flere forsendelseer. Returnerer liste med status, når status oppstod og forsendelseid. forsendelseid Id på forsendelsen. sistestatusendring Når statusen endret seg sist https://svarut.ks.no/dokumentasjon/servicev5.html 4/5
ForsendelseStatus Siste forsendelse status retrieveforsendelsehistorikk Henter historikk for en forsendelse. Returnerer en liste med beskrivelse av hva som har skjedd og når det inntraff. Listen tilsvarer ekspederingsloggen i forsendelsesoversikten. Forsendelsesid Identifikator som unikt identifiserer en forsendelse. Må være utfylt setforsendelselestaveksterntsystem Setter status for en forsendelse til lest basert på forsendelsesid. Benyttes for å sette status til lest når dokumentet har blitt lest utenfor vårt system. Forsendelsesid Identifikator som unikt identifiserer en forsendelse. Må være utfylt Fødselsnummer Fødselsnummer til brukeren som har lest forsendelsen. Ikke tomt og 11 siffer langt navnpaeksterntsystem Navn til det eksterne systemet som håndterte lesingen av forsendelsen. datolest Dato og tidpunkt som forsendelsen ble lest på. Hvis blank settes den til nåtid. https://svarut.ks.no/dokumentasjon/servicev5.html 5/5