Tekninen kuvaus Kiinteistötietojen tulostepalvelu
Palvelun kautta saat käyttöösi ajantasaisia kiinteistörekisterin sekä lainhuuto- ja kiinnitysrekisterin otteita ja tulosteita pdf-formaatissa. Palvelun tarjoamat tuotteet ja rajapinnan palvelupyyntöjen esimerkit on kuvattu alempana kohdassa Kyselyt ja esimerkit.
Yhteyden muodostaminen ja autentikointi
Yhteys palvelun ja asiakkaan välillä on SSL-suojattu (Secure Socket Layer, HTTPS-protokolla). Palveluun kirjautuminen tapahtuu käyttäjätunnuksella (palvelutunnuksella) ja salasanalla käyttäen HTTP Basic Authentication -tunnistusta. Tunnus-salasanayhdistelmä tulee tallentaa asiakkaan sovellukseen niin, että sovelluksen loppukäyttäjä ei saa sitä tietoonsa missään vaiheessa.
Tuotekohtaiset palveluosoitteet ja hakuehdot löytyvät osiosta kyselyt ja esimerkit. Käyttäjätunnuksella on pääsy vain käyttöluvassa myönnettyihin tuotekokonaisuuksiin ja tuoteversioihin. Lisätietoa tuotekokonaisuuksien sisällöstä.
Loppukäyttäjän lokitus
Kiinteistötietojen tulostepalvelun palvelinjärjestelmässä tallennetaan lokeihin tietoa myös asiakassovelluksessa tunnistetusta loppukäyttäjästä. Asiakassovelluksen tulee välittää rajapintapalvelulle tietojen loppukäyttäjän eli luonnollisen henkilön tai robotin yksilöivä tunniste jokaisen rajapintapyynnön yhteydessä.
Tunniste tulee välittää HTTP-standardin mukaisena Request Header-kenttänä nimeltään "enduserid". Tunnisteen täytyy olla merkkijono, jonka pituus saa olla max. 60 merkkiä, välilyönnit eivät ole sallittuja. Muutoin merkkijonon sisältö voi olla asiakassovelluksen määrittämä. Tunniste tulee kuitenkin olla sellainen, jonka perusteella asiakasorganisaatio voi tarvittaessa selvittää kuka henkilö on hakenut tietoja Maanmittauslaitoksen rajapintapalvelun kautta. Myös automaattisesti suoritetuilla kyselyillä tulee olla yksilöity tunniste.
Yleistä lisätietoa HTTP:n Request Header-kentistä: https://developer.mozilla.org/en-US/docs/Glossary/Request_header
Lokitietojen ja tunnisteen käytön toimivuus on hyvä varmistaa ennen tuotantopalvelun käyttöönottoa. Ota yhteyttä Maanmittauslaitokseen osoitteeseen verkkopalvelut@maanmittauslaitos.fi
Tunnisteen toimittamisen lisäksi asiakasorganisaation tulee myös itse järjestää lokitietoja säilytys kuuden vuoden ajan. Tämän jälkeen lokitiedot täytyy hävittää.
Käytettävyys ja tuki
Palvelussa on joka yö käyttökatko 23.15 - 01.00, jonka aikana rekisteritiedot päivittyvät.
Rajapinnan tekninen tuki palvelee ma - pe klo 8 - 16. Saat tukeen yhteyden verkkolomakkeella.
Sopimuksiin ja käyttäjätunnuksiin liittyvää tukea saat osoitteesta verkkopalvelut@maanmittauslaitos.fi.
Kyselyt ja esimerkit
Tässä osiossa käydään läpi tuotteiden ja tuoteversioiden kyselyosoitteet ja hakuehdot.
- Yleisiä ohjeita
- Lainhuutotodistus
- Rasitustodistus
- Vuokraoikeustodistus
- Omistajien yhteystiedot
- Vuokralaisten yhteystiedot
- Kiinteistörekisteriote
- Kiinteistörekisterin karttaote
- Muodostumisketju eteenpäin
- Muodostumisketju taaksepäin
- Voimassa olevat muodostuneet
- Muodostajarekisteriyksiköt ajankohtana
- Muodostajaselvitys
- Ote kiinteistötietojärjestelmästä (käyttöoikeusyksikkö)
Yleisiä ohjeita
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan.
Lainhuuto-, rasitus- ja vuokraoikeustodistuksista on olemassa kaksi versiota henkilötietojen laajuuden mukaan:
- henkilötunnuksellinen versio sisältää henkilön nimen, henkilötunnuksen ja osoitteen
- syntymäajallinen versio sisältää henkilön nimen ja syntymäajan
Lainhuutotodistus
Tuloste voidaan pyytää voimassa olevasta rekisteriyksiköstä, määräalasta tai erillisenä luovutetusta yhteisalueosuudesta.
Tuloste voidaan pyytää enintään sadasta kohteesta kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| maaraalatunnus | määräalatunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus |
kiinteistötunnus, määräalatunnus, |
Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen lainhuutotodistus halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
Kyselyjen URL-osoitteet
Alla olevassa taulukossa on esitetty eri tuoteversioissa käytettävä kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| lainhuutotodistus (henkilötunnus) | https://ktjws.nls.fi/ktjkir/tuloste/lainhuutotodistus/pdf?kohdetunnus=858-416-3-97&lang=fi |
| lainhuutotodistus (syntymäaika) | https://ktjws.nls.fi/ktjkir/tuloste/lainhuutotodistus_oik_tod_ilman_henkilotunnusta/pdf?kohdetunnus=858-416-3-97&lang=fi |
| oikeaksi todistettava lainhuutotodistus (henkilötunnus) | https://ktjws.nls.fi/ktjkir/tuloste/lainhuutotodistus_oik_tod/pdf?kohdetunnus=858-416-3-97&lang=fi |
| oikeaksi todistettava lainhuutotodistus (syntymäaika) | https://ktjws.nls.fi/ktjkir/tuloste/lainhuutotodistus_oik_tod_ilman_henkilotunnusta/pdf?kohdetunnus=858-416-3-97&lang=fi |
Katso esimerkki koekäyttöpalvelusta.
Rasitustodistus
Tuloste voidaan pyytää voimassa olevasta rekisteriyksiköstä, määräalasta, erillisenä luovutetusta yhteisalueosuudesta tai kirjaamisvelvollisuuden piiriin kuuluvasta erityisestä oikeudesta, jolle on annettu laitostunnus.
Tuloste voidaan pyytää enintään sadasta kohteesta kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| maaraalatunnus | määräalatunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| laitostunnus | laitostunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus |
kiinteistötunnus, määräalatunnus, laitostunnus |
Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen rasitustodistus halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
Kyselyjen URL-osoitteet
Alla olevassa taulukossa on esitetty eri tuoteversioissa käytettävä kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Rasitustodistus (henkilötunnus) | https://ktjws.nls.fi/ktjkir/tuloste/rasitustodistus/pdf?kohdetunnus=92-73-9-3&lang=fi |
| Rasitustodistus (syntymäaika) | https://ktjws.nls.fi/ktjkir/tuloste/rasitustodistus_ilman_henkilotunnusta/pdf?kohdetunnus=92-73-9-3&lang=fi |
| Oikeaksi todistettava rasitustodistus (henkilötunnus) | https://ktjws.nls.fi/ktjkir/tuloste/rasitustodistus_oik_tod/pdf?kohdetunnus=92-73-9-3&lang=fi |
| Oikeaksi todistettava rasitustodistus (syntymäaika) | https://ktjws.nls.fi/ktjkir/tuloste/rasitustodistus_oik_tod_ilman_henkilotunnusta/pdf?kohdetunnus=92-73-9-3&lang=fi |
Katso esimerkki koekäyttöpalvelusta
Vuokraoikeustodistus
Tuloste pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Tuloste voidaan pyytää voimassa olevasta kirjaamisvelvollisuuden piiriin kuuluvasta erityisestä oikeudesta, jolle on annettu laitostunnus. Tuloste voidaan pyytää enintään sadasta kohteesta kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| laitostunnus | laitostunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus | laitostunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen vuokraoikeustodistus halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
Alla olevassa taulukossa on esitetty eri tuoteversioissa käytettävä kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Vuokraoikeustodistus (henkilötunnus) | https://ktjws.nls.fi/ktjkir/tuloste/vuokraoikeustodistus/pdf?kohdetunnus=858-416-3-101-L1 |
| Vuokraoikeustodistus (syntymäaika) | https://ktjws.nls.fi/ktjkir/tuloste/vuokraoikeustodistus_ilman_henkilotunnusta/pdf?kohdetunnus=858-416-3-101-L1 |
| Oikeaksi todistettava vuokraoikeustodistus (henkilötunnus) | https://ktjws.nls.fi/ktjkir/tuloste/vuokraoikeustodistus_oik_tod/pdf?kohdetunnus=858-416-3-101-L1 |
| Oikeaksi todistettava vuokraoikeustodistus (syntymäaika) | https://ktjws.nls.fi/ktjkir/tuloste/vuokraoikeustodistus_oik_tod_ilman_henkilotunnusta/pdf?kohdetunnus=858-416-3-101-L1 |
Omistajien yhteystiedot
Tuloste voidaan pyytää rekisteriyksiköstä, määräalasta tai erillisenä luovutetusta yhteisalueosuudesta.
Tuloste voidaan pyytää enintään sadasta kohteesta kerrallaan. Tulosteella esitetään lainhuudon saajien yhteystiedot.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| maaraalatunnus | määräalatunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus |
kiinteistötunnus, määräalatunnus |
Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen tuloste halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
Alla olevassa taulukossa on esitetty eri tuoteversioissa käytettävä kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Omistajien yhteystiedot | https://ktjws.nls.fi/ktjkir/tuloste/yhteystiedot/pdf?kohdetunnus=92-73-9-3&lang=fi |
Vuokralaisten yhteystiedot
Tuloste voidaan pyytää kirjaamisvelvollisuuden piiriin kuuluvasta erityisestä oikeudesta, jolle on annettu laitostunnus. Tuloste voidaan pyytää enintään sadasta kohteesta kerrallaan. Tulosteella esitetään vuokralaisten yhteystiedot.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| laitostunnus | laitostunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus | laitostunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen tuloste halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
Alla olevassa taulukossa on esitetty eri tuoteversioissa käytettävä kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Vuokralaisten yhteystiedot | https://ktjws.nls.fi/ktjkir/tuloste/yhteystiedot/pdf?kohdetunnus=858-416-3-101-L1&lang=fi |
Kiinteistörekisteriote
Tuloste voidaan pyytää rekisteriyksiköstä tai määräalasta.
- Rekisteriyksikön kiinteistörekisteriotteita voi hakea 1-5 rekisteriyksikölle kerrallaan. Oikeaksi todistettavia vain yhden kerrallaan.
- Määräalan kiinteistörekisteriotteita (tavallinen ja oikeaksi todistettava) voi palvelusta hakea yhden kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus |
kiinteistötunnus
|
Sekä normaalimuoto että väliviivamuoto tuettuna.
|
| maaraalatunnus |
määräalatunnus
|
Sekä normaalimuoto että väliviivamuoto tuettuna.
|
| lang | fi, sv-FI | Parametri lang ei ole pakollinen. Jos parametria ei välitetä pyynnössä, palauttaa palvelu suomenkielisen kiinteistörekisteriotteen. Parametrilla lang välitetään tieto, minkä kielinen kiinteistörekisteriote halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
Alla olevassa taulukossa on esitetty eri tuoteversioissa käytettävä kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Kiinteistörekisteriote rekisteriyksiköstä | https://ktjws.nls.fi/ktjkii/tuloste/kiinteistorekisteriote/rekisteriyksikko/pdf?kiinteistotunnus=92-73-9-3&lang=fi |
| Kiinteistörekisteriote määräalasta: | https://ktjws.nls.fi/ktjkii/tuloste/kiinteistorekisteriote/maaraala/pdf?maaraalatunnus=858-416-3-101-M601&lang=fi |
| Oikeaksi todistettava kiinteistörekisteriote rekisteriyksiköstä | https://ktjws.nls.fi/ktjkii/tuloste/kiinteistorekisteriote_oik_tod/rekisteriyksikko/pdf?kiinteistotunnus=92-73-9-3&lang=fi |
| Oikeaksi todistettava kiinteistörekisteriote määräalasta | https://ktjws.nls.fi/ktjkii/tuloste/kiinteistorekisteriote_oik_tod/maaraala/pdf?maaraalatunnus=858-416-3-101-M601&lang=fi |
Kiinteistörekisterin karttaote
Karttaotteet haetaan palvelusta kaksivaiheisesti. Ensin pyydetään XML-rajapinnasta tarvittavat tiedot rekisteriyksikön tunnuksella, jonka perusteella palautetaan XML-vastaus, jossa on tarvittavat tiedot PDF -tulosteen linkin muodostamista varten ja linkit PDF -tulosteisiin. Rekisteriyksikön, jolla on yli 19 palstaa, karttaote jaotellaan korkeintaan 20-sivuisiksi tulosteiksi ja lisäksi tarjotaan linkki pelkkään palstakarttaan.
Kiinteistörekisterin karttaotteen voi pyytää vain yhdestä kohteesta (rekisteriyksikkö) kerrallaan.
Kiinteistörekisterin karttaotteen XML-rajapinnan hakuparametrit
| Nimi | Arvot | Kuvaus |
| rekisteriyksikko |
kiinteistötunnus
|
Sekä normaalimuoto että väliviivamuoto tuettuna.
|
| lang | FI, SV | Parametri lang ei ole pakollinen. Jos parametria ei välitetä pyynnössä, palauttaa palvelu linkin suomenkieliseen karttaotteeseen. Parametrilla lang välitetään tieto, minkä kielinen karttaote halutaan hakea. Mahdollisia kielivaihtoehtoja ovat FI (suomi) ja SV (ruotsi). |
Alla olevassa taulukossa on esitetty eri tuoteversioissa käytettävä kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Kiinteistörekisteriote rekisteriyksiköstä | https://ktjws.nls.fi/ktjkii/tuloste/karttaote/xml?rekisteriyksikko=47-874-1-0 |
| Oikeaksi todistettava kiinteistörekisterin karttaote | https://ktjws.nls.fi/ktjkii/tuloste/karttaote_oik_tod/xml?rekisteriyksikko=47-874-1-0 |
Skeema
<?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="karttaote">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="rekisteriyksikko" type="xsd:string" />
<xsd:element name="palstalkm" type="xsd:integer" />
<!--xsd:element name="oikeaksi_todistettava" type="xsd:boolean" /-->
<xsd:element name="lang" type="xsd:string" />
<xsd:element name="kopiointilupa" type="xsd:string" />
<xsd:element name="linkki" minOccurs="0" maxOccurs="unbounded" >
<xsd:complexType>
<xsd:sequence>
<xsd:element name="url" type="xsd:string" />
<xsd:element name="alkusivu" type="xsd:integer" />
<xsd:element name="loppusivu" type="xsd:integer" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element></xsd:schema>
Kiinteistörekisterin karttaotteen PDF-rajapinnan hakuparametrit
| Nimi | Arvot | Kuvaus |
| rekisteriyksikko |
kiinteistötunnus
|
Sekä normaalimuoto että väliviivamuoto tuettuna.
|
| lang | FI, SV | Parametri lang on pakollinen. Parametrilla lang välitetään tieto, minkä kielinen karttaote halutaan hakea. Mahdollisia kielivaihtoehtoja ovat FI (suomi) ja SV (ruotsi). |
| kopiointilupa | käyttäjäkohtainen kopiointilupanumero | Parametri kopiointilupa asetetaan XML-rajapinnan toimesta XML-rakenteeseen ja PDF -tulosteiden linkkeihin. Kopiointilupa on käyttäjäkohtainen kopiointilupanumero, joka asetetaan automaattisesti, jos käyttäjällä on kopiointilupa, jos käyttäjällä ei ole kopiointilupaa parametrin arvo jätetään tyhjäksi. |
| alkusivu | Parametri alkusivu on PDF -tulosteen ensimmäinen sivu, joka asetetaan automaattisesti XMLrajapinnan toimesta XML-rakenteeseen ja PDF -tulosteiden linkkeihin. |
|
| loppusivu | Parametri loppusivu on PDF -tulosteen viimeinen sivu, joka asetetaan automaattisesti XML-rajapinnan toimesta XML-rakenteeseen ja PDF -tulosteiden linkkeihin. |
|
| palstalkm | Parametri palstalkm on rekisteriyksikön palstalukumäärä, joka asetetaan automaattisesti XMLrajapinnan toimesta XML-rakenteeseen ja PDF -tulosteiden linkkeihin. |
Muodostumisketju eteenpäin
Tuloste voidaan pyytää yhdestä rekisteriyksiköstä kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen tuloste halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
| leikkauspvm | Päivämäärä muotoa vvvvkkpp. |
Alla olevassa taulukossa on esitetty eri tuoteversioissa käytettävä kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Muodostumisketju eteenpäin | https://ktjws.nls.fi/ktjkii/tuloste/muodostumisketju_eteenpain/pdf?kiinteistotunnus=858-416-3-63&lang=fi |
Muodostumisketju taaksepäin
Tuloste pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Tuloste voidaan pyytää yhdestä rekisteriyksiköstä kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen tuloste halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
| leikkauspvm | Päivämäärä muotoa vvvvkkpp. |
Alla olevassa taulukossa on esitetty kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Muodostumisketju taaksepäin | https://ktjws.nls.fi/ktjkii/tuloste/muodostumisketju_taaksepain/pdf?kiinteistotunnus=858-416-3-101&lang=fi |
Voimassa olevat muodostuneet
Tuloste voidaan pyytää yhdestä rekisteriyksiköstä kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen tuloste halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
| leikkauspvm | Päivämäärä muotoa vvvvkkpp. |
Alla olevassa taulukossa on esitetty kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Voimassa olevat muodostuneet | https://ktjws.nls.fi/ktjkii/tuloste/voimassa_olevat_muodostuneet/pdf?kiinteistotunnus=47-874-1-0&lang=fi |
Muodostajarekisteriyksiköt ajankohtana
Tuloste voidaan pyytää yhdestä rekisteriyksiköstä kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen tuloste halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
| leikkauspvm | Päivämäärä muotoa vvvvkkpp. Parametri on pakollinen. |
Alla olevassa taulukossa on esitetty kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Muodostajarekisteriyksiköt ajankohtana | https://ktjws.nls.fi/ktjkii/tuloste/muodostajarekisteriyksikot_ajankohtana/pdf?kiinteistotunnus=47-874-1-0&leikkauspvm=19990101&lang=fi |
Muodostajaselvitys
Tuloste voidaan pyytää viidestäkymmenestä rekisteriyksiköstä kerrallaan.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. Kiinteistötunnukset pitää antaa useana eri kiinteistotunnus-parametrina (esim. &kiinteistotunnus=85841600030100&kiinteistotunnus=85841600030101). |
| lang | fi, sv-FI | Parametrilla lang välitetään tieto, minkä kielinen tuloste halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
| leikkauspvm | Päivämäärä muotoa vvvvkkpp. Parametri on pakollinen. |
Alla olevassa taulukossa on esitetty kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Muodostajaselvitys | https://ktjws.nls.fi/ktjkii/tuloste/muodostajaselvitys/pdf?kiinteistotunnus=47-874-1-0&leikkauspvm=19990101&lang=fi |
Ote kiinteistötietojärjestelmästä (käyttöoikeusyksikkö)
Otteita voi palvelusta hakea 1-10 käyttöoikeusyksiköstä kerrallaan ja oikeaksi todistettavia otteita yhden kerrallaan.
Jos ote pyydetään useasta käyttöoikeusyksiköstä kerralla, kohdetunnukset voi antaa pilkulla erotettuna tai kohdetunnus-parametrin voi toistaa.
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| kohdetunnus |
käyttöoikeusyksikkötunnus
|
Käyttöoikeusyksikkötunnus voi olla vanhempaa Y-alkuista muotoa, esimerkiksi Y2004-11427 tai uudempaa kolmeosaista muotoa. Uudempi muoto voidaan esittää kokonaisuudessaan, esimerkiksi 000-2007-K007905 tai lyhennettynä ilman kirjaimen K jälkeisiä nollia, esimerkiksi 000-2007-K7905.
|
| lang | fi, sv-FI | Parametri lang ei ole pakollinen. Jos parametria ei välitetä pyynnössä, palauttaa palvelu suomenkielisen kiinteistörekisteriotteen. Parametrilla lang välitetään tieto, minkä kielinen ote halutaan hakea. Mahdollisia kielivaihtoehtoja ovat fi (suomi) ja sv-FI (ruotsi). |
Alla olevassa taulukossa on esitetty kyselyn URL osoite.
| Tuoteversiot | Kyselyn URL osoite |
| Ote käyttöoikeusyksiköstä | https://ktjws.nls.fi/ktjkii/tuloste/ktjote/kayttooikeusyksikko/pdf?kohdetunnus=000-2007-K007905&lang=fi |
| Oikeaksi todistettava ote yhdestä käyttöoikeusyksiköstä | https://ktjws.nls.fi/ktjkii/tuloste/ktjote_oik_tod/kayttooikeusyksikko/pdf?kohdetunnus=000-2007-K007905&lang=fi |
| Ote useasta käyttöoikeusyksiköstä | https://ktjws.nls.fi/ktjkii/tuloste/ktjote/kayttooikeusyksikko/pdf?kohdetunnus=000-2007-K007905&kohdetunnus=Y2004-11427&lang=fi |
| Oikeaksi todistettava ote useasta käyttöoikeusyksiköstä | https://ktjws.nls.fi/ktjkii/tuloste/ktjote_oik_tod/kayttooikeusyksikko/pdf?kohdetunnus=000-2007-K007905&kohdetunnus=Y2004-11427&lang=fi |
Poikkeamat yleisohjeisiin ja standardeihin
Karttaotteen tulosteet jaotellaan korkeitaan 20-sivuisiksi tulosteiksi, jolloin yhden rekisteriyksikön karttaote voi olla jaettuna usealle eri tulosteelle.
Virheiden hallinta
Kiinteistötietojen tulostepalvelun kytkeytymiseen tai saatavuuteen sekä tietoliikenteeseen liittyvistä virhe-tilanteista palautetaan asiakassovellukselle virheilmoitus HTTP-virhekoodeina. Mm. seuraavat virhekoodit voivat tulla kyseeseen:
| Virhekoodi | HTTP-tunnus | Selitys |
| 400 | Bad Request | Hakupyyntö tai sen parametrit ovat virheellisiä. |
| 401 | Unauthorized | Palvelu ei hyväksy asiakassovelluksen välittämää käyttäjätunnistetta. |
| 500 | Internal Server Error | Pyyntöä käsiteltäessä tapahtunut jokin odottamaton virhetilanne. |
| 503 | Service Unavailable | Palvelussa on liikaa ruuhkaa tai samalla käyttäjällä on liian monta samanaikaista pyyntöä. |
Jos virhetilanne liittyy kiinteistötietojen tulostepalvelusta haettaviin Kiinteistörekisteriote tulosteisiin, esim. haettua rekisteriyksikköä ei löydy, tällöin haun tuloksena palautetaan HTML-sivu HTTP-tunnuksella 200. Sivulla on virheilmoitus suomeksi ja ruotsiksi, ”Virheellinen kiinteistötunnus. Felaktig fastighetsbeteckning.”.
Jos virhetilanne liittyy kiinteistötietojen tulostepalvelusta haettaviin karttaote tulosteisiin, virheellisellä rekisteriyksikön tunnuksella haettaessa XML-rajapinta palauttaa XML-rakenteen, jossa ei ole linkkejä PDF-tulosteisiin. Jos pyynnöstä puuttuu pakollisia parametreja palvelu palauttaa virheen HTTP-tunnuksella 500 ja virheilmoitustekstillä.