Tietopalvelurajapinnat

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