Rekisteripalvelun Rest-rajapintojen käyttö

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:

  • Y-tunnus
  • Raportointikokonaisuus
  • Raportointikausi
  • Hyväksyntävaihe
  • Hyväksymisaika
  • Url-osoite tunnuslukuja varten

Tunnuslukuhaun tuloksissa on seuraavat tiedot:

  • Y-tunnus
  • Raportointikokonaisuus
  • Raportointikausi
  • Hyväksyntävaihe
  • Hyväksymisaika
  • Taksonomia
  • Tunnusluku (taksonomian mukainen numerokoodi)
  • Tunnusluvun arvo
  • Tarkastushavainnon ilmoitus
  • Tarkastushavainnon tarkennus
  • Tarkastushavainnon vakavuus
  • Kieli

Rajapinnan nykyisessä versiossa on tuettuna hyväksymisvaiheet ja rajapinnan kieliversiot. Alla kuvattuna molempien rajapintahakujen osoitemuodot.

Aineistotietojen haku

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.

  • Versio: v1
  • Formaatti: json tai xml
  • Esimerkki: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/aineistot

Tiettyyn aineistoon kuuluvien tunnuslukujen haku

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.

  • Versio: v1
  • Formaatti: json, xml
  • Hyväksyntävaihe (fi): alustava, hyväksytty, lopullinen
  • Hyväksyntävaihe (sv): preliminär, godkänt, slutlig
  • Hyväksyntävaihe (en): initial, approved, final
  • Raportointikokonaisuus: ktas
  • Ytunnus on kunnan ytunnus. Esimerkiksi 000162-0
  • Kausi: esim. 2019
  • Esimerkki: https://prodkuntarest.westeurope.cloudapp.azure.com/rest/v1/json/tunnusluvut/alustava/ktas/9000162-0/2016

Aikaisemmin Url-poluissa oli mukana kielikoodi, mutta nykyisessä rajapinnassa kieli määräytyy automaattisesti Url-kutsujen mukaan (avainsanoina: aineistot, collection, samling, dokumentti, document, dokument).