1.12.2015 KS Svarut forvaltning 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 servicepassord. Avsender opprettes av KSSvarUt administrator/organisasjons administrator og servicepassordet genereres av avsender ansvarlig via konfigurasjon (/konfigurasjon/)siden. Tjenester Forsendelsesservicet tilbyr følgende funksjonalitet: sendForsendelse Hovedtjeneste som sender inn forsendelse til ekspedering av KSSvarUt. Følgende metadata inkluderes: Felt Beskrivelse Validering 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. Adresse1 Adresselinje1 Adresse2 Adresselinje2 Adresse3 Adresselinje3 Postnr Postnummer Må være utfylt Poststed Poststed Må være utfylt Land Land Fødselsnr Hvis Privat, må være utfylt for å kunne levere til altinn. Orgnr Hvis organisasjon, må være utfylt for å kunne levere til altinn. https://svarut.ks.no/dokumentasjon/serviceV5.html Må være utfylt 1/5 1.12.2015 KS Svarut forvaltning Avgivende system Identifikator som identifiserer systemet som gjør webservice 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 printleverandør. ^[azAZ09\\.øæåØÆÅ] {0,20}$ Printkonfigurasjon Konfigurasjon for hvordan dokumentet skal printes, dobbeltsidig, fargeprint, APost, BPost KunDigitalLevering 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. kryptert 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) krevNiva4Innlogging Forsendelsen krever nivå 4innlogging 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 Filnavn er for intern bruk, må være unikt i en forsendelse. Mimetype Mimetype på være application/pdf hvis den skal til print. Kun digital levering er valgt kan vi ta imot annet. Data Fildata GiroarkSider Liste med sidetall som skal printes på https://svarut.ks.no/dokumentasjon/serviceV5.html Kun application/pdf hvis den skal til print 2/5 1.12.2015 KS Svarut forvaltning gult giroark. Digital versjon vil få grått giroark. Første side er 1. Liste med Lenker Metadata fra avleverende system Rekkefølgen er samme som de vil komme i brevet. Kan være tom. Url lenke Selve lenken til dokument/nettside Må være utfylt og være i gyldig lenke format, altså (http/https/ftp)://(nettside). (com/no/ etc) Url tekst Mimetype på være application/pdf. Kun det som blir støttet nå. Må være utfylt Ledetekst Teksten som kommer før lenken i brevet Noark5 metadata fra avleverende system, foreløbig oversikt Saksekvensnummer Saksaar Journalaar Journalseksvensnummer Journalpostnummer Journalposttype Journalstatus Journaldato DokumentetsDato Tittel Saksbehandler EkstraMetadata Metadata i mottakende system Liste med key,value for forskjellige behov. Keys må være unique. 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 1.12.2015 KS Svarut forvaltning Saksaar Journalposttype Journalstatus DokumentetsDato Tittel retrieveForsendelseStatus Henter status for en forsendelse. En forsendelse kan ha en av tilstandene beskrevet under: Tilstander (normalløp): Mottatt Et kall mottatt på forsendelsesservice. 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 1.12.2015 KS Svarut forvaltning 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. Felt Beskrivelse Validering 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. Felt Beskrivelse Validering 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
© Copyright 2024