MottakerServiceV1

Download Report

Transcript MottakerServiceV1

MottakerServiceV1
Her beskrives funksjonalitet for MottakerServiceV1
Denne versjonen er under utvikling og kan
foreløpig endres på kort varsel.
WSDL (../tjenester/mottakerservice/MottakerServiceV1?
wsdl)
Tilgang
For å benytte servicen må en bruke HTTP Basic autentication med mottakerid og service­passord.
Mottakere opprettes av KS­SvarUt administrator og service­passordet genereres av person med
tilgang via mottaker (/mottaker/)­siden.
Tjenester
MottakerServiceV1 tilbyr følgende funksjonalitet:
hentNyeForsendelser
Tjeneste for å hente nye forsendelser som er klar for import.
Notis: Vi henter forsendelser for mottakerid som ble brukt i Basic autentiseringen.
hentForsendelsefil
Tjeneste for å hente filen for en gitt forsendelse. Hvis forsendelsen består flere filer er de enten
pakket i en samlet PDF eller en .zip fil.
Felt
Beskrivelse
Validering
Forsendelseid
Identifikator som unikt identifiserer en forsendelse.
Må være utfylt
Notis for .Net
Når man henter WSDL i .NET blir filtypen til "byte[]", selv om den egentlig skal være en stream. Det
kan fikses ved å manuelt endre WSDL­en på denne måten: <wsdl:definitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schem
as.xmlsoap.org/wsdl/" xmlns:tns="http://www.ks.no/svarut/services" xmlns:soap12="http:/
/schemas.xmlsoap.org/wsdl/soap12/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http" nam
e="MottakerServiceV1" targetNamespace="http://www.ks.no/svarut/services">
<wsdl:types>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xmime="http://www.
w3.org/2005/05/xmlmime" xmlns:tns="http://www.ks.no/svarut/services" elementFormDefault
="unqualified" targetNamespace="http://www.ks.no/svarut/services" version="1.0">
...
<xs:complexType name="hentForsendelseFilResponse">
<xs:sequence>
<xs:element minOccurs="0" name="return" type="xs:base64Binary" xmime:e
xpectedContentTypes="application/octet‐stream"/>
</xs:sequence>
</xs:complexType>
til <wsdl:definitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schem
as.xmlsoap.org/wsdl/" xmlns:tns="http://www.ks.no/svarut/services" xmlns:soap12="http:/
/schemas.xmlsoap.org/wsdl/soap12/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http" nam
e="MottakerServiceV1" targetNamespace="http://www.ks.no/svarut/services">
<wsdl:types>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns3="http://schem
as.microsoft.com/Message" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" xmlns:tns="h
ttp://www.ks.no/svarut/services" elementFormDefault="unqualified" targetNamespace="http
://www.ks.no/svarut/services" version="1.0">
...
<xs:complexType name="hentForsendelseFilResponse">
<xs:sequence>
<xs:element minOccurs="0" name="return" maxOccurs="1" type="ns3:Stream
Body" />
</xs:sequence>
</xs:complexType>
Dette gir en "System.IO.Stream" som argument istedenfor.
settForsendelseMottatt
Tjeneste for å kvittere på at en forsendelse er mottatt. Forsendelsesstatus vil bli satt til lest og
forsendelsen vil ikke bli sendt til print gitt at den ikke allerede har blitt sendt.
Felt
Beskrivelse
Validering
Forsendelseid
Identifikator som unikt identifiserer en forsendelse.
Må være utfylt