Användning av registertjänstens Rest-gränssnitt

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:

  • FO-nummer
  • Rapporteringshelhet
  • Rapporteringsperiod
  • Godkännandeskede
  • Tid för godkännande
  • URL-adress för nyckeltalet

Resultaten från sökningen av nyckeltal innehåller följande uppgifter:

  • FO-nummer
  • Rapporteringshelhet
  • Delhelhet
  • Rapporteringsperiod
  • Godkännandeskede
  • Tid för godkännande (datum för godkännande)
  • Taxonomi
  • Nyckeltal (sifferkod enligt taxonomin)
  • Nyckeltalets värde
  • Anmälan om en granskningshändelse
  • Precisering av en granskningshändelse
  • Granskningshändelsens allvarlighet
  • Språk

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.

Sökning av materialuppgifter (ej TOLT)

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.

  • Version: v1
  • Format: json, xml, xbrl eller ixbrl
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/samling

Sökning av HKLMY/KKLMY-materialuppgifter

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.

  • Version: v1
  • Format: json, xml
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/kklmy-samling

Sökning av TOLT-materialuppgifter

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.

  • Version: v1
  • Format: json, xml, xbrl eller ixbrl
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/tolt-samling

Sökning av nyckeltal som hör till ett visst material

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.

  • Version: v1
  • Format: json, xml
  • Godkännandeskede (fi): alustava, hyvaksytty, lopullinen, jalkikorjattu
  • Godkännandeskede (sv): preliminar, godkant, slutlig, efterreviderat
  • Godkännandeskede (en): initial, approved, final, afterwards_revised
  • Rapporteringshelhet: ktas, kknr osv. (ej tolt)
  • Kommunens Fo-nummer är FO-numret. Till exempel 000162-0
  • Period: till exempel 2019
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/dokument/preliminar/ktas/9000162-0/2016

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).

Sökning av ett visst TOLT-material

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.

  • Version: v1
  • Format: json, xml
  • Godkännandeskede (fi): alustava, hyvaksytty, lopullinen, jalkikorjattu
  • Godkännandeskede (sv): preliminar, godkant, slutlig, efterreviderat
  • Godkännandeskede (en): initial, approved, final, afterwards_revised
  • Rapporteringshelhet: tolt, htolt
  • Kommunens Fo-nummer är FO-numret. Till exempel 000162-0
  • Period: till exempel 2019
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/tolt-dokument/preliminar/tolt/9000162-0/2016

Sökning av ett visst HKLMY/KKLMY-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.

  • Version: v1
  • Format: json, xml
  • Godkännandeskede (fi): alustava, hyvaksytty, lopullinen, jalkikorjattu
  • Godkännandeskede (sv): preliminar, godkant, slutlig, efterreviderat
  • Godkännandeskede (en): initial, approved, final, afterwards_revised
  • Rapporteringshelhet: KKLMY, HKLMY
  • FO-numret är kommunens eller välfärdsområdes Fo-nummer. Till exempel 000162-0
  • Period: till exempel 2019
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/kklmy-dokument/preliminar/KKLMY/9000162-0/2016

Periodiserad kvartalsrapportering av kommuner och samkommuner

Till statistikcentralen samlar man också in s.k. periodiserade nyckeltal för kommunernas och samkommunernas kvartalsrapportering. Dessa tal ska inte förväxlas med talen som fås via det ovan beskrivna dokumentgränssnittet och som används i kommunernas och samkommunernas kvartalsrapportering (KKNR). Det finns mycket färre periodiserade "korrigeringstal" än egentliga KKNR-tal, så alla periodiserade nyckeltal i databasen fås från gränssnittet på en gång. Gränssnittet är på finska.

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.

  • Version: v1
  • Format: json, xml
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/suoriteperusteiset-tunnusluvut

Sökning av skyddade materialuppgifter

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.

  • Version: v1
  • Format: json, xml, xbrl tai ixbrl
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/v1/json/samling?key=xyzrthjk....

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.

Sökning av skyddade nyckeltal

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.

  • Version: v1
  • Format: json, xml
  • Godkännandeskede (fi): alustava, hyvaksytty, lopullinen, jalkikorjattu
  • Godkännandeskede (sv): preliminar, godkant, slutlig, efterreviderat
  • Godkännandeskede (en): initial, approved, final, afterwards_revised
  • Rapporteringshelhet: ktas, kknr osv. (ej tolt)
  • Kommunens Fo-nummer är FO-numret. Till exempel 000162-0
  • Period: till exempel 2019
  • Exempel: https://prodkuntarest.westeurope.cloudapp.azure.com/srest/v1/json/dokument/preliminar/9000162-0/2016?key=xyzrthjk....

I json- och xml-formaten har sökningens status kopplats till sökresultaten till exempel för att utreda identifieringsfel. Xbrl- och ixbrl-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.