Kehittäjät-etusivulle  Ilmoitin.fi/kehittäjät

Tarkastusrajapinta

Ilmoitin.fi-palvelu tarjoaa Web Services -rajapinnan ilmoitusten muodollisen oikeellisuuden tarkastukseen. Palvelu perustuu Web service -teknologiaan, jossa aineisto välitetään tarkastettavaksi SOAP-protokollaa käyttäen.

Palvelu on tarkoitettu vain aineiston muodollisen oikeellisuuden tarkastamiseen eikä rajapinnan kautta voi lähettää aineistoa eteenpäin. Aineiston lähetys tapahtuu lähetysrajapinnan kautta.

WSDL:ssä on kuvattu palvelun kutsumiseen tarvittavat parametrit ja palvelun osoite.
Ohessa palvelun WSDL-kuvaus. Huom! WSDL-tiedoston soap:address location -kohdan oikea arvo on https://www.ilmoitin.fi/webservicesNH/ApiTaMoNH

Kutsussa käytettävät parametrit ovat seuraavat:

  • Ilmoitus sisältää tarkastettavan ilmoituksen
  • Kieli kertoo ilmoituksen kielen. Sallittuja arvoja ovat FI (suomi), SE (ruotsi) ja EN (englanti)
  • Tyyppi kertoo minkä tyyppisenä järjestelmä palauttaa tarkistuksen tuloksen. Parametrin arvo on aina 1, eli XML.
  • Vastaanotto parametrin arvo on aina 0.

Vastaussanomassa eli SOAP-response:ssa palautetaan aineiston tarkastuksen tulos. Tarkastustulos palautetaan SOAP-body:ssa XML-muodossa. Alla tarkastustuloksen XML-skeema sekä kuvaus skeeman rakenteesta:

Tarkastusrajapinta on vapaasti käytettävissä, mutta Verohallinto toivoo, että käyttäjät ilmoittavat käyttöönotosta osoitteeseen tamo.tk (at) vero.fi. Tietoa tarvitaan mm. käyttökatkoista tiedottamiseen.