Tietopalvelurajapinnat

Versio 0.2
29.6.2018

Ohessa on luettelo rajapintapalveluun toteutettavista tuotteista. Tuotteita voi tulla lisää ja ne voivat vielä muuttua.

Esitettävien henkilötietojen laajuuden mukaan tuotteista toteutetaan eri versioita. Viranomaiskäyttöön varten voidaan toteuttaa myös muita tuotteita.

Yleistä:

  • Kyselypalvelut palauttavat joko pdf-tulosteen tai json-rakenteen.
  • Tulosteiden (pdf) osioiden tietosisällöt ovat tarjolla erillisinä kyselypalveluina (json).
  • Kyselypalveluista julkaistavat tiedot tarkentuvat myöhemmin.
  • Nyt julkaistaviin tietoihin voidaan joutua tekemään muutoksia.
  • Tuotteista toteutetaan henkilötietojen laajuuden mukaan eri versioita.


Kyselypalvelut (pdf)

Tuotetta pyydetään palvelusta HTTPS-protokollaan perustuvalla kyselyllä. Metodina on GET. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Vastauksena palautetaan pdf-tuloste.

Yhtiön osakeluettelo

  • yleiskuvaus: yhtiöstä tuotettava tuloste koko yhtiön osakeluettelosta
  • hakuehdot: y-tunnus
  • tietosisältö: tulosteen osioina yhtiön perustiedot ja osakeryhmittäin osakeluetteloon merkityt omistajat

Osakehuoneistotuloste

  • yleiskuvaus: osakeryhmästä tuotettava tuloste mm. vaihdantaan ja panttaukseen
  • hakuehdot: osakeryhmätunnus
  • tietosisältö: tulosteen osioina yhtiön ja osakeryhmän perustiedot, osakeryhmän hallintakohteet, osakeryhmän omistusoikeudet, osakeryhmän panttioikeudet, osakeryhmän vallintarajoitukset ja osakeryhmän muut rajoitukset


Kyselypalvelut (json)

Tuotetta pyydetään palvelusta HTTPS-protokollaan perustuvalla kyselyllä. Metodina on GET. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Vastauksena palautetaan JSON-rakenne.

Yhtiöiden haku hakuehdoin

  • yleiskuvaus: hakupalvelu yhtiön perustietojen (y-tunnusten) saamiseksi
  • hakuehdot: useita hakuehtoja
  • tietosisältö: yhtiön tunnistetiedot

Yhtiön perustiedot

  • yleiskuvaus: tuote, jossa esitetään yhtiöstä tulosteille tulostuvat perustiedot
  • hakuehdot: y-tunnus
  • tietosisältö: yhtiön perustiedot

Yhtiön osakeluettelo

  • yleiskuvaus: tuote, jossa esitetään tulosteelle "Yhtiön osakeluettelo" tulostuvat tiedot
  • hakuehdot: y-tunnus
  • tietosisältö: yhtiön perustiedot, yhtiön osakeryhmät ja niiden osakeluetteloon merkityt omistajat

Yhtiön hallintakohteet

  • yleiskuvaus: tuote, jossa esitetään yhtiön rakennuksissa olevat huoneistot, autopaikat ja muut tilat sekä rakennusten ulkopuolella olevat autopaikat ja muut tilat.
  • hakuehdot: y-tunnus
  • tietosisältö: yhtiön perustiedot, yhtiön hallintakohteet

Yhtiön rajoitukset

  • yleiskuvaus: tuote, jossa esitetään yhtiölle kirjatut rajoitusmerkinnät
  • hakuehdot: y-tunnus
  • tietosisältö: yhtiön perustiedot, yhtiölle kirjatut rajoitusmerkinnät

Osakeryhmien haku hakuehdoin

  • yleiskuvaus: hakupalvelu osakeryhmän perustietojen (osakeryhmätunnusten) saamiseksi
  • hakuehdot: useita hakuehtoja
  • tietosisältö: osakeryhmän tunnistetiedot

Osakeryhmän perustiedot

  • yleiskuvaus: tuote, jossa esitetään osakeryhmästä tulosteille tulostuvat perustiedot
  • hakuehdot: osakeryhmätunnus
  • tietosisältö: osakeryhmän perustiedot

Osakeryhmän hallintakohteet

  • yleiskuvaus: tuote, jossa esitetään tulosteelle "Osakehuoneistotuloste" tulostuvat osakeryhmän hallintakohteet
  • hakuehdot: osakeryhmätunnus
  • tietosisältö: osakeryhmän perustiedot, osakeryhmän hallintakohteet

Osakeryhmän omistusoikeudet

  • yleiskuvaus: tuote, jossa esitetään tulosteelle "Osakehuoneistotuloste" tulostuvat osakeryhmän omistusoikeudet
  • hakuehdot: osakeryhmätunnus
  • tietosisältö: osakeryhmän perustiedot, osakeryhmälle kirjatut omistusoikeudet (kirjaamisasiat, omistusosuudet ja omistajat)

Osakeryhmän panttioikeudet

  • yleiskuvaus: tuote, jossa esitetään tulosteelle "Osakehuoneistotuloste" tulostuvat osakeryhmän panttioikeudet
  • hakuehdot: osakeryhmätunnus
  • tietosisältö: osakeryhmän perustiedot, osakeryhmälle kirjatut panttioikeudet (kirjaamisasiat, panttioikeudet ja pantinsaajat)

Osakeryhmän rajoitukset

  • yleiskuvaus: tuote, jossa esitetään tulosteelle "Osakehuoneistotuloste" tulostuvat osakeryhmän vallintarajoitukset ja muut rajoitukset
  • hakuehdot: osakeryhmätunnus
  • tietosisältö: osakeryhmän perustiedot, osakeryhmälle kirjatut rajoitusmerkinnät (kirjaamisasiat sekä rajoitusten tiedot)

Koodistot

  • yleiskuvaus: tuote koodistoarvojen selitteiden saamiseksi
  • hakuehdot: ei hakuehtoja
  • tietosisältö: kaikkien tietopalvelukoodistojen koodiarvot ja selitteet

Versio 0.1
8.3.2018

Kyselypalvelut

Kyselypalvelu toteutetaan REST-tyylisenä rajapintana. Vastaukset kyselyihin annetaan JSON-formaattia käyttäen. Vastaavat palvelut ovat saatavilla myös Suomi.fi-palveluväylän kautta XML-formaatissa.

Kaikki tuotteista esitetyt tiedot ovat tässä vaiheessa alustavia. Määrittelyjä tarkennetaan tämän vuoden aikana. Varsinaiset skeematiedostot julkaistaan myöhemmin.

Tuote: Yhtiön omistukset

Yleiskuvaus

Tuote, jossa esitetään yhtiön osakeluettelon tiedot.

Tuotetta pyydetään palvelusta HTTPS-protokollaan perustuvalla kyselyllä. Metodina on GET. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Vastauksena palautetaan yhtiöstä tulostettu JSON-rakenne.

Tietosisältö

Tulosrakenne Yhtiön laajat tiedot, josta tähän tuotteeseen tulostetaan:

Hakuehdot

Tuotetta voi pyytää ainakin yhtiön y-tunnuksella. Muita mahdollisia hakuehtoja määritellään myöhemmin.

Tuote: Yhtiön hallintakohteet

Yleiskuvaus

Tuote, jossa esitetään yhtiön rakennuksissa olevat huoneistot, autopaikat ja muut tilat sekä rakennusten ulkopuolella olevat autopaikat ja muut tilat.

Tuotetta pyydetään palvelusta HTTPS-protokollaan perustuvalla kyselyllä. Metodina on GET. Kyselyyn sisältyvät parametrit, joiden mukaista tietoa haetaan. Vastauksena palautetaan yhtiöstä tulostettu JSON-rakenne.

Tietosisältö

Tulosrakenne Yhtiön laajat tiedot, josta tähän tuotteeseen tulostetaan:

Hakuehdot

Tuotetta voi pyytää ainakin yhtiön y-tunnuksella. Muita mahdollisia hakuehtoja määritellään myöhemmin.

Tietojen kuvaukset

Tietojen kuvaukset, versio 0.1, 8.3.2018

Koodistot, versio 0.1, 8.3.2018