Sökningen av nyckeltal via Rest-gränssnitten sker i två faser. Först hämtar man alla materialuppgifter som finns i tjänsten. Resultatgruppen är enligt eget val antingen i json- eller xml-format. Med resultatgruppens koduppgifter (FO-nummer, rapporteringshelhet osv.) väljer man det önskade materialet och för resultatgruppen finns en färdig URL-adress med vilken man kan leta efter nyckeltal för just det aktuella materialet. I de färdiga kodernas sökadresser används samma överföringsformat som också användes för att hämta allt material, dvs. om allt material har begärts i xml-format, parametreras även URL-adresserna i datalistan för xml-baserade nyckeltalslistor. Det är lätt att skapa en URL-adress som hämtar nyckeltalen per maskin. Man måste göra på detta sätt om man vill ändra parametervärdena för en färdig sökning av nyckeltalet (såsom granskningshändelsernas språk).
Resultaten från materialsökningen innehåller följande uppgifter:
Resultaten från sökningen av nyckeltal innehåller följande uppgifter:
I den nuvarande versionen av gränssnittet stöds godkännandeskedena och gränssnittets språkversioner. Adressformen för bägge gränssnittssökningar beskrivs här nedan.
Adressform på finska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/aineistot
Adressform på engelska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/collection
Adressform på svenska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/samling
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
Adressform på finska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/kklmy-aineistot
Adressform på engelska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/kklmy-collection
Adressform på svenska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/kklmy-samling
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
TOLTA, TOLTB, HTOLA, HTOLB, TOLT, HTOLT
Adressform på finska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/tolt-aineistot
Adressform på engelska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/tolt-collection
Adressform på svenska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/tolt-samling
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
Adressform på finska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/dokumentti/<godkännandeskede (fi)>/<rapporteringshelhet>/<FO-nummer>/<period>
Adressform på svenska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/dokument/<godkännandeskede (sv)>/<rapporteringshelhet>/<FO-nummer>/<period>
Adressform på engelska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/document/<godkännandeskede (en)>/<rapporteringshelhet>/<FO-nummer>/<period>
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
Tidigare fanns det en språkkod i URL-sökvägarna, men i det nuvarande gränssnittet bestäms språket automatiskt enligt URL-inbjudningarna (nyckelord: aineistot, collection, samling, dokument, document).
TOLTA, TOLTB, HTOLA, HTOLB, TOLT, HTOLT
Adressform på finska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/tolt-dokumentti/<godkännandeskede (fi)>/<rapporteringshelhet>/<FO-nummer>/<period>
Adressform på svenska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/tolt-dokument/<godkännandeskede (sv)>/<rapporteringshelhet>/<FO-nummer>/<period>
Adressform på engelska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/tolt-document/<godkännandeskede (en)>/<rapporteringshelhet>/<FO-nummer>/<period>
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
Obs! Till ansökan om TOLT-material har fogats en parameter för rapporteringshelheter, eftersom man för närvarande via TOLT-gränssnittet hämtar alla TOLT-typiska uppgifter och med samma FO-nummer har man kunnat ange olika typer av material.
Adressform på finska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/kklmy-dokumentti/<godkännandeskede (fi)>/<rapporteringshelhet>/<FO-nummer>/<period>
Adressform på svenska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/kklmy-dokument/<godkännandeskede (sv)>/<rapporteringshelhet>/<FO-nummer>/<period>
Adressform på engelska: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/kklmy-document/<godkännandeskede (en)>/<rapporteringshelhet>/<FO-nummer>/<period>
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
För Statistikcentralen samlas också in s.k. prestationsbaserade nyckeltal för kommunernas, samkommunernas och välfärdsområdenas kvartalsrapportering. Dessa siffror får inte förväxlas med de siffror som fås via det dokumentationsgränssnitt som beskrivs ovan och som används i kommunernas, samkommunernas och välfärdsområdenas kvartalsrapportering. Antalet prestationsbaserade ”korrigeringstal” är mycket mindre än de egentliga nyckeltalen, vilket innebär att alla prestationsbaserade nyckeltal i databasen fås på en gång via gränssnittet. Gränssnittet är finskspråkigt.
En del av de prestationsbaserade nyckeltalen omfattas av skyddade nyckeltal. Gränssnittet för skyddade prestationsbaserade nyckeltal är IP-begränsat och användningen av det kräver en s.k. API-nyckel. Nyckeln till de prestationsspecifika skyddade nyckeltalen är organisationsspecifik och med den är det endast möjligt att hämta uppgifter om prestationsspecifika nyckeltal. Gränssnittet för skyddade prestationsbaserade nyckeltal returnerar både skyddade och offentligt tillgängliga prestationsbaserade nyckeltal. Åtkomst till skyddade gränssnitt söks hos Statskontoret genom att kontakta adressen kuntadata@valtiokonttori.fi. Rättigheterna gäller endast en viss tid och efter giltighetstiden ska nya tillträdesrättigheter sökas.
Sökning efter offentliga prestationsbaserade nyckeltal
Adressform: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/<version>/<format>/suoriteperusteiset-tunnusluvut
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
Sökning efter offentliga och skyddade prestationsbaserade nyckeltal
Adressform: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<version>/<format>/suoriteperusteiset-tunnusluvut?key=<API-nyckel>
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
Adressform på finska: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<version>/<format>/aineistot?key=<API-nyckel>
Adressform på engelska: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<version>/<format>/collection?key=<API-nyckel>
Adressform på svenska: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<version>/<format>/samling?key=<API-nyckel>
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
Alla gränssnitt för skyddat material är IP-begränsade och kräver en s.k. API-nyckel. Nycklarna är organisations- och rapporteringshelhetsspecifika (till exempel TOTT och KKTPP). Tillgång till skyddade gränssnitt söks hos Statskontoret genom att ta kontakt via adressen kuntadata@valtiokonttori.fi. Rättigheterna är i kraft endast under en utsatt tid och efter giltighetstiden ska man ansöka om nya åtkomsträttigheter.
Organisationerna kan ha flera API-nycklar. Varje API-nyckel har endast åtkomst till en viss rapporteringshelhet. Materialsökningen filtrerar det material som nycklarnas rättigheter tillåter att visas.
Resultaten från de skyddade materialsökningarna har färdiga URL-adresser, men dessa adresser saknar delen om API-nyckeln. För att sökningen ska fungera ska användarna lägga till API-nyckeln i slutet av de angivna URL-adresserna antingen manuellt eller per maskin.
Adressform på finska: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<version>/<format>/dokumentti/<godkännandeskede (fi)>/<rapporteringshelhet>/<FO-nummer>/<period>?key=<API-nyckel>
Adressform på svenska: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<version>/<format>/dokument/<godkännandeskede (sv)>/<rapporteringshelhet>/<FO-nummer>/<period>?key=<API-nyckel>
Adressform på engelska: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/<version>/<format>/document/<godkännandeskede (en)>/<rapporteringshelhet>/<FO-nummer>/<period>?key=<API-nyckel>
Vinkelparenteserna har endast använts för att märka ut adressformens parameterdelar. Dessa tecken bör inte användas för riktiga adresser.
I json- och xml-formaten har sökningens status kopplats till sökresultaten till exempel för att utreda identifieringsfel. Xbrl-materialen har producerats i förväg och dessa format kan inte paketeras på samma sätt som ovan nämnda format utan att innehållsformatet går sönder, men även i dessa fall ges separata felmeddelanden i xml-format i anslutning till identifieringsproblemen. Det tillförlitligaste sättet att identifiera felsituationerna är per maskin med hjälp av statuskoderna i http-protokollet.