04 - Tampuuri API

Tämä dokumentti on siirretty confluenceen

Table of Contents

Yleistä
Sisältö
API-kuvaukset
1. Testaus (QA = Quality assurance)
2. Tuotanto

Yleistä

Ohjelmointirajapinta (engl. Application programming interface, API) on määritelmä, jonka mukaan eri ohjelmat voivat tehdä pyyntöjä ja vaihtaa tietoja eli keskustella keskenään. Hyvä esimerkki rajapinnasta on käyttöjärjestelmän rajapinta, jolla ohjelmat voivat käyttää keskusmuistia sekä tiedostoja.

Tampuuri API on REST tyyppinen rajapinta Tampuurista tietojen hakemiseen sekä Tampuurin tietojen päivittämiseen. Tampuuri API on kehitetty ulkoiseksi rajapinnaksi Tampuurin ja kolmannen osapuolen sovelluksien välille. TampuuriX, Tampuuri Phone sekä Tampuuri Tablet sovellukset käyttävät myös Tampuuri APIa toiminnoissaan.

Kuva: Tampuuri API ja iso kuva

Sisältö

Osio	Kuvaus
Asuntotarkastus	Asuntotarkastuksien hakemiseen ja tallentamiseen liittyvät operaatiot
Autopaikat	Autopaikkavarauksien hakemiseen sekä tekemiseen liittyvät operaatiot
Avainhallinta	Avainlainauksien hakemiseen ja tekemiseen liittyvät operaatiot
Dokumenttipankki	Dokumenttipankin liitteiden selaamiseen, lisäämiseen sekä poistamiseen liittyvät operaatiot
Hakemus	Hakemuksien hakemiseen sekä tekemiseen liittyvät opereaatiot
Hankintaehdotus	Hankintaehdotuksien hakemiseen sekä tekemiseen liittyvät operaatiot
Huoltotehtävä	Huoltotehtävien hakemiseen sekä kuittaamiseen liittyvät operaatiot
Ilmoitushallinta	Ilmoituksien hakemiseen, tekemiseen sekä tilamuutoksiin liittyvät operaatiot
Kohde	Kohderekisterin tietojen hakemiseen sekä tietojen päivittämiseen liittyvät operaatiot
KohdeAsukastieto	Asukashallinnan asukastietojen hakuun liittyvä operaatio
KohdeVaruste	Kohderekisterin varustetietojen hakuun liittyvät operaatiot
Kunnossapito	Kunnossapidon PTS remonttien hakemiseen, lisäämiseen sekä tilamuutoksiin liittyvät operaatiot
Lasku	Erillislaskujen hakuun liittyvä operaatio
Osapuoli	Henkilö- sekä Yritysrekisterin hakuihin, lisäyksiin sekä tietojen päivityksiin liittyvät operaatiot
OsapuoliYhteydenotto	Asukkaidehn yhteydenottoihin liittyvät haku sekä lisäys operaatiot
Saunavuoro	Saunavuorohallinnan hakuihin sekä lisäyksiin liittyvät operaatiot
Sopimus	Reskontran sopimushallintaan liittyvät operaatiot
Tarjous	Tarjouksiin liittyvät haku sekä tilamuutos operaatiot
Tehtava	Tehtävien hakemiseen liittyvät opereaatiot
Tiedosto	Tiedostojen hakuun liittyvät operaatiot
Viestinta	Kohteen tiedotteiden hakuun liittyvät operaatiot