Tekninen kuvaus Kiinteistötietojen kyselypalvelu (REST)
Yhteys palvelun ja asiakkaan välillä on SSL-suojattu (Secure Socket Layer, HTTPS-protokolla). Palveluun pitää kirjautua sisään antamalla käyttäjätunnus ja salasana. Käytössä on HTTP Basic Authentication -tunnistus, jonka on oltava mukana jokaisessa pyynnössä. Kiinteistötietojen kyselypalvelu (REST) kerää hakuihin liittyviä tilasto- ja laskutustietoja palvelupyyntöjen perusteella käyttäjätunnuksittain jaoteltuna.
Palvelu on käytettävissä ma - su klo 00.15 - 23.15.
Loppukäyttäjien lokitus
Kiinteistötietojen Kyselypalvelun palvelinjärjestelmässä tallennetaan lokeihin tietoa myös asiakassovelluksessa tunnistetusta loppukäyttäjästä, mikäli asiakassovellus välittää rajapintapalvelulle loppukäyttäjää identifioivan tunnisteen kunkin rajapintapyynnön yhteydessä.
Teknisesti rajapintapalvelun kutsuissa tunniste tulee välittää HTTP-standardin mukaisena Request Header-kenttänä nimeltään "enduserid" ja jonka arvon tulee olla merkkijono (välilyönnit ei sallittuja, pituus max. 60 merkkiä). Muutoin merkkijonon sisältö voi olla asiakassovelluksen määrittämä, mutta kuitenkin siten, että tarvittaessa tunnisteen perusteella on selvitettävissä loppukäyttäjä asiakassovelluksen ylläpitäjän toimesta.
Yleistä lisätietoa HTTP:n Request Header-kentistä: https://developer.mozilla.org/en-US/docs/Glossary/Request_header
Lokitietojen siirron toimivuus on hyvä varmistaa ottamalla yhteyttä Maanmittauslaitokseen osoitteeseen verkkopalvelut@maanmittauslaitos.fi
Lisäksi lokitietoja tulee säilyttää kuuden vuoden ajan, jonka jälkeen ne tulee poistaa.
Aineistot ja tuotteet
Palvelun skeemat
Koko palvelun skeemat zip-pakettina:
http://xml.nls.fi/XML/Schema/sovellus/ktjkir/kios-report-api-6.0-src.zip (voit kopioida osoitteen selaimen osoiteriville, mikäli se ei ala latautua linkkiä klikkaamalla)
Skeemat tuotteittain
Kyselyt ja esimerkit
Perustiedot
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Perustiedot voidaan pyytää enintään sadasta kohteesta (rekisteriyksikkö, määräala ja laitos) kerrallaan.
Laitoksen perustiedoissa esitetään henkilötietoja. Eri asiakasryhmiä varten on olemassa seuraavat tuoteversiot:
- kaikki skeeman mukaiset henkilötiedot esitetään
- luonnollisen henkilön henkilötunnusta ei esitetä
- luonnollisen ja tuntemattoman henkilön henkilötietoja ei esitetä
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. |
Esimerkiksi perustiedot laitoksesta, kaikki henkilötiedot:
https://ktjws.nls.fi/ktjkir/kysely/perustiedot/kohde/xml?laitostunnus=858-416-3-101-L1
Esimerkkitiedosto vastauksesta
Esimerkiksi perustiedot laitoksesta ilman henkilötunnusta:
https://ktjws.nls.fi/ktjkir/kysely/perustiedot_ilman_henkilotunnusta/kohde/xml?laitostunnus=858-416-3-101-L1
Esimerkkitiedosto vastauksesta
Esimerkiksi perustiedot laitoksesta ilman henkilötietoja:
https://ktjws.nls.fi/ktjkir/kysely/perustiedot_ilman_henkilotietoja/kohde/xml?laitostunnus=858-416-3-101-L1
Esimerkkitiedosto vastauksesta
Lainhuutotiedot
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Lainhuutotiedot voidaan pyytää sadasta kohteesta (rekisteriyksikkö ja määräala) kerrallaan.
Eri asiakasryhmiä varten on olemassa seuraavat tuoteversiot:
- kaikki skeeman mukaiset henkilötiedot esitetään
- luonnollisen henkilön henkilötunnusta ei esitetä
- luonnollisen ja tuntemattoman henkilön henkilötietoja ei esitetä
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. |
Esimerkiksi lainhuutotiedot rekisteriyksiköstä, kaikki henkilötiedot:
https://ktjws.nls.fi/ktjkir/kysely/lainhuutotiedot/xml?kiinteistotunnus=858-416-3-101
Esimerkkitiedosto vastauksesta
Esimerkiksi lainhuutotiedot rekisteriyksiköstä ilman henkilötunnusta:
https://ktjws.nls.fi/ktjkir/kysely/lainhuutotiedot_ilman_henkilotunnusta/xml?kiinteistotunnus=858-416-3-101
Esimerkkitiedosto vastauksesta
Esimerkiksi lainhuutotiedot rekisteriyksiköstä ilman henkilötietoja:
https://ktjws.nls.fi/ktjkir/kysely/lainhuutotiedot_ilman_henkilotietoja/xml?kiinteistotunnus=858-416-3-101
Esimerkkitiedosto vastauksesta
Rasitustiedot
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Rasitustiedot voidaan pyytää sadasta kohteesta (rekisteriyksikkö, määräala tai laitos) kerrallaan.
Eri asiakasryhmiä varten on olemassa seuraavat tuoteversiot:
- kaikki skeeman mukaiset henkilötiedot esitetään
- luonnollisen henkilön henkilötunnusta ei esitetä
- luonnollisen ja tuntemattoman henkilön henkilötietoja ei esitetä
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. |
Esimerkiksi rasitustiedot rekisteriyksiköstä, kaikki henkilötiedot:
https://ktjws.nls.fi/ktjkir/kysely/rasitustiedot/xml?kiinteistotunnus=858-416-3-115
Esimerkkitiedosto vastauksesta
Esimerkiksi rasitustiedot rekisteriyksiköstä ilman henkilötunnusta:
https://ktjws.nls.fi/ktjkir/kysely/rasitustiedot_ilman_henkilotunnusta/xml?kiinteistotunnus=858-416-3-115
Esimerkkitiedosto vastauksesta
Esimerkiksi rasitustiedot rekisteriyksiköstä ilman henkilötietoja:
https://ktjws.nls.fi/ktjkir/kysely/rasitustiedot_ilman_henkilotietoja/xml?kiinteistotunnus=858-416-3-115
Esimerkkitiedosto vastauksesta
Vuokraoikeustiedot
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Vuokraoikeustiedot voidaan pyytää sadasta kohteesta (laitos) kerrallaan.
Eri asiakasryhmiä varten on olemassa seuraavat tuoteversiot:
- kaikki skeeman mukaiset henkilötiedot esitetään
- luonnollisen henkilön henkilötunnusta ei esitetä
- luonnollisen ja tuntemattoman henkilön henkilötietoja ei esitetä
Hakuparametrit
| Nimi | Arvot | Kuvaus |
| laitostunnus | laitostunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus | laitostunnus | Sekä normaalimuoto että väliviivamuoto tuettuna. |
Esimerkiksi vuokraoikeustiedot laitoksesta, kaikki henkilötiedot:
https://ktjws.nls.fi/ktjkir/kysely/vuokraoikeustiedot/xml?laitostunnus=858-416-3-101-L1
Esimerkkitiedosto vastauksesta
Esimerkiksi vuokraoikeustiedot laitoksesta ilman henkilötunnusta:
https://ktjws.nls.fi/ktjkir/kysely/vuokraoikeustiedot_ilman_henkilotunnusta/xml?laitostunnus=858-416-3-101-L1
Esimerkkitiedosto vastauksesta
Esimerkiksi vuokraoikeustiedot laitoksesta ilman henkilötietoja:
https://ktjws.nls.fi/ktjkir/kysely/vuokraoikeustiedot_ilman_henkilotietoja/xml?laitostunnus=858-416-3-101-L1
Esimerkkitiedosto vastauksesta
Henkilön omistukset
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Henkilön omistukset voidaan pyytää yhdeltä omistajalta (henkilö- tai y-tunnus) kerrallaan.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| henkilotunnus | henkilötunnus | 0..1 | Kirjainkoko ei merkitsevä |
| ytunnus | y-tunnus | 0..1 | |
| tunnus | henkilötunnus, y-tunnus | 0..1 | Kirjainkoko ei merkitsevä |
| kunta | kuntatunnus | 0..1 | Sekä etunollallinen että etunollaton kuntatunnus tuettuna. |
| rooli |
Koodiston Rooli arvot: LHHS = Lainhuudon saaja LVSA = Luovutuksen saaja LHOS = Omistusoikeuden saaja EOVU = Vuokralainen LHHV = Hallinnoiva viranomainen |
0..n | Koodiston muut arvot eivät ole sallittuja. |
| kohdelaji |
Sallitut arvot: KI = Rekisteriyksikkö MA = Määräala RT = Rekisteröity tontinvuokraoikeus VO = Vuokraoikeus, jolla on laitostunnus |
0..n |
Esimerkiksi henkilön omistukset henkilötunnuksella:
https://ktjws.nls.fi/ktjkir/kysely/omistustiedot/tunnus/xml?henkilotunnus=xxxxxx-xxxx
Esimerkkitiedosto vastauksesta
Rekisteriyksiköiden haku hakuehdoin
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan.
Hakutapa: Rekisteriyksiköiden haku kiinteistötunnuksella
Hakutavalla voidaan pyytää xml-rakennetta sadalla kohteella (rekisteriyksikkö) kerrallaan.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| kiinteistotunnus | kiinteistötunnus | 1..n | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus | kiinteistötunnus | 1..n | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| olotila |
Koodiston Olotila arvot: 1 = Voimassaoleva 2 = Lakannut |
0..n | |
| rekisteriyksikkolaji | Koodiston Rekisteriyksikkolaji arvot | 0..n | |
| maapintaalaAlku | Pinta-ala neliömetreinä, kokonaisluku | 0..1 | Pinta-alavälin alkuarvo. Raja-arvo sisältyy hakutulokseen. |
| maapintaalaLoppu | Pinta-ala neliömetreinä, kokonaisluku | 0..1 | Pinta-alavälin loppuarvo. Raja-arvo sisältyy hakutulokseen. |
Esimerkiksi: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/rekisteriyksikko/kohde/xml?kiinteistotunnus=91-17-16-1
Esimerkkitiedosto vastauksesta
Hakutapa: Rekisteriyksiköiden haku kunnalla
Hakutavalla voidaan pyytää xml-rakennetta yhdellä kohteella (kunta) kerrallaan.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| kunta | kuntatunnus | 1 | Sekä etunollallinen että etunollaton kuntatunnus tuettuna. Hakee kohteet, jotka tällä hetkellä sijaitsevat annetussa kunnassa. |
| rekisteriyksikonNimi | Rekisteriyksikön nimi tai nimen osa ja jokerimerkki, esim. koivikk* | 0..1 | Kirjainkoko ei merkitsevä. Ehdossa voidaan antaa nimen alkuosa, jokerimerkkinä tähti (*). |
| olotila |
Koodiston Olotila arvot: 1 = Voimassaoleva 2 = Lakannut |
0..n | |
| rekisteriyksikkolaji | Koodiston Rekisteriyksikkolaji arvot | 0..n | |
| maapintaalaAlku | Pinta-ala neliömetreinä, kokonaisluku | 0..1 | Pinta-alavälin alkuarvo. Raja-arvo sisältyy hakutulokseen. |
| maapintaalaLoppu | Pinta-ala neliömetreinä, kokonaisluku | 0..1 | Pinta-alavälin loppuarvo. Raja-arvo sisältyy hakutulokseen. |
Esimerkiksi haku kuntaparametrilla: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/rekisteriyksikko/kunta/xml?kunta=261
Esimerkiksi haku kunta- ja rekisteriyksikonNimi -parametreilla:
https://ktjws.nls.fi/ktjkir/kysely/perustiedot/rekisteriyksikko/kunta/xml?rekisteriyksikonNimi=Koivula&kunta=261
Esimerkkitiedosto vastauksesta
Hakutapa: Rekisteriyksiköiden haku muutoksilla
Hakutavalla voidaan pyytää xml-rakennetta rekisterissä muuttuneista kohteista. Kysely palauttaa rekisteriyksiköt, jotka ovat muuttuneet annetun muutostapahtumalajin mukaisesti annetulla aikavälillä. Vastaukseen tulostetaan myös annetuilla hakuparametreilla löytyneet muutostapahtumat.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| muutostapahtumalaji | Koodiston Muutostapahtumalaji arvot | 1 |
Poimitaan rekisteriyksiköt, joissa on tapahtunut annetun muutostapahtumalajin mukainen muutos. |
| muutospvmAlku | Päivämäärä muodossa vvvv-kk-pp | 1 | Muutosaikavälin alkupäivä. Raja-arvo sisältyy hakutulokseen. |
| muutospvmLoppu | Päivämäärä muodossa vvvv-kk-pp | 1 | Muutosaikavälin loppupäivä. Raja-arvo sisältyy hakutulokseen. |
| kunta | kuntatunnus | 0..1 | Sekä etunollallinen että etunollaton kuntatunnus tuettuna. Kuntatunnuksen pois jättäminen tekee haun koko Suomesta. Hakee kohteet, jotka tällä hetkellä sijaitsevat annetussa kunnassa. |
| olotila |
Koodiston Olotila arvot: 1 = Voimassaoleva 2 = Lakannut |
0..n | |
| rekisteriyksikkolaji | Koodiston Rekisteriyksikkolaji arvot | 0..n | |
| maapintaalaAlku | Pinta-ala neliömetreinä, kokonaisluku | 0..1 | Pinta-alavälin alkuarvo. Raja-arvo sisältyy hakutulokseen. |
| maapintaalaLoppu | Pinta-ala neliömetreinä, kokonaisluku | 0..1 | Pinta-alavälin loppuarvo. Raja-arvo sisältyy hakutulokseen. |
Esimerkiksi uudet rekisteriyksiköt 16.-17.2.2015 Espoosta: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/rekisteriyksikko/muutos/xml?muutostapahtumalaji=203&muutospvmAlku=2015-02-16&muutospvmLoppu=2015-02-17&kunta=049
Esimerkkitiedosto vastauksesta
Määräalojen haku hakuehdoin
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan.
Hakutapa: Määräalojen haku määräalatunnuksella
Hakutavalla voidaan pyytää xml-rakennetta sadalla kohteella (määräala) kerrallaan.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| maaraalatunnus | määräalatunnus | 1..n | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus | määräalatunnus | 1..n | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| olotila |
Koodiston Olotila arvot: 1 = Voimassaoleva 2 = Lakannut |
0..n |
Esimerkiksi: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/maaraala/kohde/xml?kohdetunnus=05040100010012M0601
Esimerkkitiedosto vastauksesta
Hakutapa: Määräalojen haku kunnalla
Hakutavalla voidaan pyytää xml-rakennetta yhdellä kohteella (kunta) kerrallaan.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| kunta | kuntatunnus | 1 | Sekä etunollallinen että etunollaton kuntatunnus tuettuna. Hakee kohteet, jotka tällä hetkellä sijaitsevat annetussa kunnassa. |
| olotila |
Koodiston Olotila arvot: 1 = Voimassaoleva 2 = Lakannut |
0..n |
Esimerkiksi: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/maaraala/kunta/xml?kunta=050
Esimerkkitiedosto vastauksesta
Hakutapa: Määräalojen haku muutoksilla
Hakutavalla voidaan pyytää xml-rakennetta rekisterissä muuttuneista kohteista. Kysely palauttaa määräalat, jotka ovat muuttuneet annetun muutostapahtumalajin mukaisesti annetulla aikavälillä. Vastaukseen tulostetaan myös annetuilla hakuparametreilla löytyneet muutostapahtumat.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| muutostapahtumalaji | Koodiston Muutostapahtumalaji arvot | 1 |
Poimitaan määräalat, joissa on tapahtunut annetun muutostapahtumalajin mukainen muutos. |
| muutospvmAlku | Päivämäärä muodossa vvvv-kk-pp | 1 | Muutosaikavälin alkupäivä. Raja-arvo sisältyy hakutulokseen. |
| muutospvmLoppu | Päivämäärä muodossa vvvv-kk-pp | 1 | Muutosaikavälin loppupäivä. Raja-arvo sisältyy hakutulokseen. |
| kunta | kuntatunnus | 0..1 | Sekä etunollallinen että etunollaton kuntatunnus tuettuna. Kuntatunnuksen pois jättäminen tekee haun koko Suomesta. Hakee kohteet, jotka tällä hetkellä sijaitsevat annetussa kunnassa. |
| olotila |
Koodiston Olotila arvot: 1 = Voimassaoleva 2 = Lakannut |
0..n |
Esimerkiksi uudet määräalat 16.-17.2.2015 Espoosta: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/maaraala/muutos/xml?muutostapahtumalaji=203&muutospvmAlku=2015-02-16&muutospvmLoppu=2015-02-17&kunta=049
Esimerkkitiedosto vastauksesta
Laitosten haku hakuehdoin
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan.
Hakutapa: Laitosten haku laitostunnuksella
Hakutavalla voidaan pyytää xml-rakennetta sadalla kohteella (laitos) kerrallaan.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| laitostunnus | laitostunnus | 1..n | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| kohdetunnus | laitostunnus | 1..n | Sekä normaalimuoto että väliviivamuoto tuettuna. |
| olotila |
Koodiston Olotila arvot: 0 = Vireillä 1 = Voimassaoleva 2 = Lakannut |
0..n |
Esimerkiksi: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/laitos/kohde/xml?kohdetunnus=05040100020047L0001
Esimerkkitiedosto vastauksesta
Hakutapa: Laitosten haku kunnalla
Hakutavalla voidaan pyytää xml-rakennetta yhdellä kohteella (kunta) kerrallaan.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| kunta | kuntatunnus | 1 | Sekä etunollallinen että etunollaton kuntatunnus tuettuna. Hakee kohteet, jotka tällä hetkellä sijaitsevat annetussa kunnassa. |
| olotila |
Koodiston Olotila arvot: 0 = Vireillä 1 = Voimassaoleva 2 = Lakannut |
0..n |
Esimerkiksi: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/laitos/kunta/xml?kunta=050
Esimerkkitiedosto vastauksesta
Hakutapa: Laitosten haku kiinteistötunnuksella
Hakutavalla voidaan pyytää xml-rakennetta sadalla kohteella (kiinteistötunnus) kerrallaan.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
|
kohdetunnus kiinteistotunnus |
kiinteistötunnus | 0..100 | Sekä normaalimuoto ja tavuviivamuoto tuettuna |
| olotila |
Koodiston Olotila arvot: 0 = Vireillä 1 = Voimassaoleva 2 = Lakannut |
0..n |
Esimerkiksi: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/laitos/kiinteisto/xml?kiinteistotunnus=91-10-631-5
Hakutapa: Laitosten haku muutoksilla
Hakutavalla voidaan pyytää xml-rakennetta rekisterissä muuttuneista kohteista. Kysely palauttaa laitokset, jotka ovat muuttuneet annetun muutostapahtumalajin mukaisesti annetulla aikavälillä. Vastaukseen tulostetaan myös annetuilla hakuparametreilla löytyneet muutostapahtumat.
Hakuparametrit
| Nimi | Arvot | Lkm | Kuvaus |
| muutostapahtumalaji | Koodiston Muutostapahtumalaji arvot | 1 |
Poimitaan laitokset, joissa on tapahtunut annetun muutostapahtumalajin mukainen muutos. |
| muutospvmAlku | Päivämäärä muodossa vvvv-kk-pp | 1 | Muutosaikavälin alkupäivä. Raja-arvo sisältyy hakutulokseen. |
| muutospvmLoppu | Päivämäärä muodossa vvvv-kk-pp | 1 | Muutosaikavälin loppupäivä. Raja-arvo sisältyy hakutulokseen. |
| kunta | kuntatunnus | 0..1 | Sekä etunollallinen että etunollaton kuntatunnus tuettuna. Kuntatunnuksen pois jättäminen tekee haun koko Suomesta. Hakee kohteet, jotka tällä hetkellä sijaitsevat annetussa kunnassa. |
| olotila |
Koodiston Olotila arvot: 0 = Vireillä 1 = Voimassaoleva 2 = Lakannut |
0..n |
Esimerkiksi laitokset, joilla vuokraoikeuden muutos on hyväksytty lainvoimaisesti 8.-12.12.2014 Espoosta: https://ktjws.nls.fi/ktjkir/kysely/perustiedot/laitos/muutos/xml?muutostapahtumalaji=112&muutospvmAlku=2014-12-08&muutospvmLoppu=2014-12-12&kunta=049
Esimerkkitiedosto vastauksesta
Yhteystiedot
XML-rakenne pyydetään palvelusta HTTPS/GET-protokollaan perustuvalla kyselyllä. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Yhteystiedot voidaan pyytää sadasta kohteesta (rekisteriyksikkö, määräala tai laitos) 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. |
Esimerkiksi yhteystiedot useasta kohteesta:
https://ktjws.nls.fi/ktjkir/kysely/yhteystiedot/xml?kohdetunnus=638-414-1-301-M603,858-416-3-101,698-3-101-19-L1,444-1-106-12
Esimerkkitiedosto vastauksesta
Koodistot
Koodistojen nimet ja arvot xml-muodossa. Koodiston avaaminen vaatii käyttäjätunnuksen.
Url: https://ktjws.nls.fi/ktjkir/kysely/koodistot/xml
Versiohallinta
Sovellusversio 6.0 (suunniteltu käyttöönotto helmikuu 2018)
Kaikki skeematiedostot zip-pakettina
Esimerkkitiedostot:
- Rasitustiedot (muistutusasiaTyypin luovutuskirjanpvm)
- Rasitustiedot (muistutuslajin vakioselite)
Sovellusversio 5.2 (suunniteltu käyttöönotto 5.10.2017)
Sovellusversio sisältää vain joitakin sovelluksen sisäisiä parannuksia.
Sovellusversio 5.1 (suunniteltu käyttöönotto 1.6.2017)
Sovellusversio sisältää vain joitakin sovelluksen sisäisiä parannuksia.
Sovellusversio 5.0 (9.2.2017)
Kaikki skeematiedostot zip-pakettina (Päivitetty 22.12.2016, edellinen päivitys 30.11.2016)
Esimerkkitiedosto (Lainhuutotiedot)
Sovellusversio 4.2 (8.10.2016)
Sovellusversio sisältää vain joitakin sovelluksen sisäisiä parannuksia.
Käyttöönoton aiheuttama käyttökatko palvelussa perjantaina 7.10. klo 16:30 alkaen. Palvelu on käytettävissä viimeistään lauantaina 8.10. klo 16:00.
Sovellusversio 4.1 (12.5.2016)
Sovellusversio sisältää vain joitakin sovelluksen sisäisiä parannuksia.
Sovellusversio 4.0 (17.3.2016)
Käyttökatko palvelussa 16.3.2016 klo 17:00 - 17.3.2016 klo 8:00.
Tiedote 3.3.2016
Tiedote 15.1.2016
Koodistot ja koodistomuutokset
Sovellusversio 3.3 (3.12.2015)
Käyttökatko palvelussa 2.12.2015 klo 16:30 - 3.12.2015 klo 8:00. Sovellusversio sisältää vain joitakin sovelluksen sisäisiä parannuksia.
Sovellusversio 3.2 (8.10.2015)
Käyttökatko palvelussa 7.10.2015 klo 16:15 - 8.10.2015 klo 8:00.
Tiedote 17.9.2015
Tiedote 14.7.2015
Koodistot ja koodistomuutokset
Sovellusversio 3.1 (4.6.2015)
Käyttökatko palvelussa 3.6.2015 klo 16:30 - 4.6.2015 klo 8:00. Sovellusversio sisältää vain joitakin sovelluksen sisäisiä parannuksia.
Sovellusversio 3.0 (2.3.2015)
Tiedote 19.3.2015
Tiedote 23.2.2015
Koodistot ja koodistomuutokset
Sovellusversio 2.4 (1.10.2014)
Tiedote 26.9.2014
Tiedote 19.5.2014
Tiedote 7.5.2014
Version kaikki skeematiedostot zip-pakettina:
http://xml.nls.fi/XML/Schema/sovellus/ktjkir/kios-report-api-2.4-src.zip
Koodistot ja koodistomuutokset
Esimerkkitiedostot:
- Perustiedot
- Lainhuutotiedot
- Rasitustiedot
- Vuokraoikeustiedot
- Omistustiedot
- Yhteystiedot
- Rekisteriyksiköiden haku hakuehdoin
- Määräalojen haku hakuehdoin
- Laitosten haku hakuehdoin
Sovellusversio 2.3 (4.6.2014)
Sovellusversio sisältää vain joitakin sovelluksen sisäisiä parannuksia.
Sovellusversio 2.2 (14.4.2014)
Tiedote 7.4.2014
Sovellusversio 2.1 (10.2.2014)
Tiedote 4.2.2014
Tiedote 2.10.2013
Sovellusversio 2.0 (23.10.2013)
Virheiden hallinta
Palveluun 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. |
| 403 | Forbidden | Käyttäjälle ei ole oikeuksia tuotteeseen |
| 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öä. |