Gränssnittsförfrågningar i registren

Webbtjänsten gör en gränssnittsförfrågan till kundorganisationens gränssnitt via sin anslutningsserver och Suomi.fi-informationsleden I SOAP-genomförandena har förfrågan följande form:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
   <SOAP-ENV:Header>
       <xrd:client id:objectType="SUBSYSTEM">
           <id:xRoadInstance>FI</id:xRoadInstance>
           <id:memberClass>GOV</id:memberClass>
           <id:memberCode>0245437-2</id:memberCode>
           <id:subsystemCode>ServiceViewClient</id:subsystemCode>
       </xrd:client>
       <xrd:service id:objectType="SERVICE">
          <id:xRoadInstance>FI</id:xRoadInstance>
          <id:memberClass>GOV</id:memberClass>
          <id:memberCode>000000-1</id:memberCode>
          <id:subsystemCode>TestSystem</id:subsystemCode>
          <id:serviceCode>testService</id:serviceCode>
       </xrd:service>
       <xrd:protocolVersion>4.0</xrd:protocolVersion>
       <xrd:id></xrd:id>
       <xrd:userId></xrd:userId>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
       <ns1:testService xmlns:ns1="http://x-road.fi/producer">
          <request>
             <ssn>123456-2111</ssn>
          </request>
       </ns1:testService>
    </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>

Uppgifterna om varje aktör som erbjuder data till Informationsleden kompletteras innanför <xrd:service id:objectType="SERVICE">-taggarna.

Svaret på en förfrågan som gjorts med personbeteckning är ett XML-meddelande som godkänts av Informationsleden och där de data som ska läsas finns innanför <response></response>-taggarna. I Suomi.fi-webbtjänsten visas svaret enkelt stiliserat för slutanvändaren enligt Handlebars-templaten.

Det är viktigt att beakta att all data som visas ska finnas i svaren innanför response-taggen. Syftet med webbtjänsten är alltså inte att kombinera information från olika datakällor, utan det är kundorganisationens adaptertjänst (eller det interna datasystemet) som sköter den saken. Informationen får inte heller finnas bifogat till meddelandet (attachment) eller som ett kodsystem som ska öppnas i webbtjänsten.

Svaret har formen:

<?xml version="1.0" encoding="utf-8" ?> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:id="http://x-road.eu/xsd/identifiers" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"> 

    <SOAP-ENV:Header> 

       <xrd:client id:objectType="SUBSYSTEM"> 

          <id:xRoadInstance>FI</id:xRoadInstance> 

          <id:memberClass>GOV</id:memberClass> 

          <id:memberCode>0245437-2</id:memberCode> 

          <id:subsystemCode>ServiceViewClient</id:subsystemCode> 

       </xrd:client> 

       <xrd:service id:objectType="SERVICE"> 

       <id:xRoadInstance>FI</id:xRoadInstance> 

       <id:memberClass>GOV</id:memberClass> 

       <id:memberCode>000000-1</id:memberCode> 

       <id:subsystemCode>TestSystem</id:subsystemCode> 

       <id:serviceCode>testService</id:serviceCode> 

       </xrd:service> 

       <xrd:userId>test</xrd:userId> 

       <xrd:id>ID11234</xrd:id> 

       <xrd:protocolVersion>4.0</xrd:protocolVersion> 

    </SOAP-ENV:Header> 

    <SOAP-ENV:Body> 

       <ts1:testServiceResponse xmlns:ts1="http://test.x-road.fi/producer"> 

       <request> 

          <ssn>123456-2111</ssn> 

       </request> 

       <response> 

          <nimi>Mallidata</nimi> 

          <aika>TI 31.2.2016 15:00</aika> 

          <lisatieto>malliksi</lisatieto> 

          </response> 

       </ts1:testServiceResponse> 

    </SOAP-ENV:Body> 

 </SOAP-ENV:Envelope> 

Stiliseringen av HTML-elementen som visas i det här exemplet kommer från stilguiden för webbtjänsten, men kundorganisationen får framföra önskemål om strukturen.