Tunnuslukujen haku Rest-rajapintojen kautta tapahtuu kaksivaiheisesti. Ensiksi haetaan kaikki palvelusta löytyvät aineistotiedot. Tulosjoukko on valinnan mukaan joko json- tai xml-muotoinen. Tulosjoukon tunnistetiedoilla (ytunnus, raportointikokonaisuus jne) valitaan haluttu aineisto ja tulosjoukkoon valmiiksi koostetulla Url-osoitteella saadaan kyseiseen aineistoon liittyvät tunnusluvut. Valmiissa tunnuslukujen hakuosoitteissa käytetään samaa siirtomuotoa, jolla haettiin kaikki aineistotkin eli jos kaikki aineistot on pyydetty xml-formaatissa niin ko aineistolistauksessa olevat Url-osoitteet on myös parametroitu xml-pohjaisia tunnuslukulistauksia varten. Tunnusluvut hakeva Url-osoite on helppo muodostaa koneellisestikin. Näin joudutaan toimimaan jos valmiin tunnuslukuhaun oletusarvoja (kuten tarkistustapausten kielisyyttä) halutaan muuttaa.
Aineistohaun tuloksissa on seuraavat tiedot:
Tunnuslukuhaun tuloksissa on seuraavat tiedot:
Rajapinnan nykyisessä versiossa on tuettuna hyväksymisvaiheet ja rajapinnan kieliversiot. Alla kuvattuna molempien rajapintahakujen osoitemuodot.
Kauden 2022C03 KKNR taksonomian summahierarkiassa on virhe korkokulujen summauksessa. Summahierarkia jättää tilin 6255 Korkokulut lainoista ulkopuolisilta summaamatta korkokuluihin (6200-6299 Korkokulut). Poikkeamasta tarkemmin.
Tämä virhe vaikuttaa myös tilikauden ylijäämä (alijäämä) summaukseen.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/aineistot
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/collection
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/samling
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kklmy-aineistot
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kklmy-collection
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kklmy-samling
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/tolt-aineistot
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/tolt-collection
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/tolt-samling
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kkytt-aineistot
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kkytt-collection
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kkytt-samling
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
KKYTT-lisäaineistoihin kuuluvat k-t18.02, k-t20.01, k-t21.02, k-t21.03 ja k-t21.04 osakokonaisuudet.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/dokumentti/<hyväksyntävaihe suomeksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/dokument/<hyväksyntävaihe ruotsiksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/document/<hyväksyntävaihe englanniksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Aikaisemmin Url-poluissa oli mukana kielikoodi, mutta nykyisessä rajapinnassa kieli määräytyy automaattisesti Url-kutsujen mukaan (avainsanoina: aineistot, collection, samling, dokumentti, document, dokument).
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/tolt-dokumentti/<hyväksyntävaihe suomeksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/tolt-dokument/<hyväksyntävaihe ruotsiksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/tolt-document/<hyväksyntävaihe englanniksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Huom! TOLT-aineistohakuihin on lisätty raportointikokonaisuusparametri, koska nykyään TOLT-rajapinnan kautta haetaan myös HTOLT-tiedot ja samalla ytunnuksella on voitu ilmoittaa sekä TOLT- että HTOLT-aineistoja.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kklmy-dokumentti/<hyväksyntävaihe suomeksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kklmy-dokument/<hyväksyntävaihe ruotsiksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kklmy-document/<hyväksyntävaihe englanniksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kkytt-dokumentti/<hyväksyntävaihe suomeksi>/<ytunnus>/<kausi>
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kkytt-document/<hyväksyntävaihe englanniksi>/<ytunnus>/<kausi>
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/kkytt-dokument/<hyväksyntävaihe ruotsiksi>/<ytunnus>/<kausi>
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
KKYTT-lisäaineistoihin kuuluvat k-t18.02, k-t20.01, k-t21.02, k-t21.03 ja k-t21.04 osakokonaisuudet. Hakutulos sisältää listat näille osakokonaisuuksille.
Tilastokeskusta varten kerätään myös ns. suoriteperusteiset kuntien ja kuntayhtyminen neljännesvuosiraportointiin käytettävät tunnusluvut. Näitä lukuja ei pidä sekoittaa yllä kuvatun dokumentti-rajapinnan kautta saataviin kuntien ja kuntayhtymien neljännesvuosiraportoinnissa käytettäviin lukuihin (kknr). Suoriteperusteisia "korjauslukuja" on paljon vähemmän kuin varsinaisia kknr-lukuja, joten rajapinnasta saadaan kerralla kaikki tietokannan suoriteperusteiset tunnusluvut. Rajapinta on suomenkielinen
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<versio>/<formaatti>/suoriteperusteiset-tunnusluvut
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<versio>/<formaatti>/aineistot?key=api_avain_merkkijono_tähän
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<versio>/<formaatti>/collection?key=api_avain_merkkijono_tähän
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<versio>/<formaatti>/samling?key=api_avain_merkkijono_tähän
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Kaikki suojattujen aineistojen rajapinnat ovat IP-rajattuja ja vaativat ns. api avaimen. Avaimet ovat organisaatio- ja raportointikokonaisuuskohtaisia (esim. TOTT ja KKTPP). Pääsyä suojattuihin rajapintoihin haetaan Valtiokonttorista ottamalla yhteyttä osoitteeseen kuntadata@valtiokonttori.fi. Oikeudet ovat voimassa vain määräajan ja voimassaoloajan jälkeen tulee hakea uudet pääsyoikeudet.
Organisaatioilla voi olla useita api avaimia. Kullakin api avaimella on pääsyoikeus vain tiettyyn raportointikokonaisuuteen. Aineistohaku suodattaa näyttämänsä aineiston avainten oikeuksien perusteella.
Suojattujen aineistohakujen tuloksissa on mukana valmis Url-osoite, mutta näistä osoitteista puuttuu api avainten osuus. Käyttäjien pitää lisätä api avain annettujen Url-osoitteiden loppuun joko manuaalisesti tai ohjelmallisesti, jotta annettu haku toimisi.
Osoitemuoto: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<versio>/<formaatti>/dokumentti/<hyväksyntävaihe suomeksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>?key=api_avain_merkkijono_tähän
Osoitemuoto ruotsiksi: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<versio>/<formaatti>/dokument/<hyväksyntävaihe ruotsiksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>?key=api_avain_merkkijono_tähän
Osoitemuoto englanniksi: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<versio>/<formaatti>/document/<hyväksyntävaihe englanniksi>/<raportointikokonaisuus>/<ytunnus>/<kausi>?key=api_avain_merkkijono_tähän
Kulmasulkeilla on vain merkitty osoitemuodon parametriosat. Kyseisiä merkkejä ei tule käyttää todellisissa osoitteissa.
Hakutuloksiin on json- ja xml-muodoissa liitetty haun statustietoja esimerkiksi tunnistautumisvirheiden selvittämiseksi. Xbrl- ja ixbrl-sisällöt taas on tuotettu valmiiksi etukäteen ja näitä formaatteja ei voi paketoida samalla tavalla kuin edellä mainittuja formaatteja ilman että sisältöformaatti rikkoutuisi, mutta näissäkkin tapauksissa annetaan erillisiä xml-muotoisia virheilmoituksia tunnistautumisongelmiin liittyen. Luotettavimmin virhetilanteet on ohjelmallisesti tunnistettavissa http-protokollan statuskoodeilla.