Tampuuri API Help

Kutsun headerit

Jokaisessa Tampuuri API:in kohdistuvassa kutsussa tulee olla seuraavat header-tiedot:

1
2
3
4
5
6
7
8
9
X-TampuuriAvain: XXXXXXXX-XXXX-XXXX
X-AsiakasNimi: Visma Tampuuri Oy
X-Ohjelmistoversio: AsiakasOhjelmistoX_v1.4.2
X-TiliNimi: graniitti.tampuuri.fi
X-Kayttajatunnus: kayttajatunnus
X-Salasana: ********
X-Lat: 60.2298830
X-Long: 25.0087430
Content-Type: application/json
  1. Tampuuri-Avain, jolla kirjaudutaan järjestelmään ja kirjataan transaktiolokimerkinnät (laskutuksen pohja).
  2. Tampuuri-Avaimen kanssa käsikädessä kulkeva asiakasnimi. Tämän ja TampuuriAvaimen perusteella kutsu joko hyväksytään tai hylätään Cloudissa.
  3. Tunnistettava ohjelmistoversio, esim. Latomo_v2.8 tai WP_v1.5
  4. Tampuuri-Tilin nimi. Tilinimi on globaalisti uniikki. Tilit, joilla rest-operaatiot toimii nähtävissä.
  5. Tampuuri-käyttäjän käyttäjätunnus
  6. Tampuuri-käyttäjän salasana
  7. Kutsun lähetyspaikan Latitude-koordinaatti. Käytetään yleensä mobiililaitteissa. Ei pakollinen.
  8. Kutsun lähetyspaikan Longitude-koordinaatti. Käytetään yleensä mobiililaitteissa. Ei pakollinen.
  9. Kutsun content-type. Yleensä application/json

Asumisoikeus

APIDescription
GET sopimukset/{sopimus_id}/asumisoikeus/saldo Palauttaa sopimuksen asumisoikeusmaksujen saldot per tavoitekausi.
POST sopimukset/{sopimus_id}/asumisoikeus/asolaskelma Tekee asumisoikeuslaskelman mikäli sitä ei jo ole, muuten päivitetään vanhaa.
POST sopimukset/{sopimus_id}/asumisoikeus/luopumislaskelma Tekee asumisoikeusluopumislaskelman mikäli sitä ei jo ole, muuten päivitetään vanhaa.

Asuntotarkastus

APIDescription
GET asuntotarkastukset/{asuntotarkastus_id} HUOM! Tämä reitti on vanhentunut, käytetään tarkastukset nimiavaruuden reittejä. Palauttaa asuntotarkastuksen tiedot.
POST asuntotarkastukset/sisaanmuuttotarkastukset?sopimus_id={sopimus_id} HUOM! Tämä reitti on vanhentunut, käytetään tarkastukset nimiavaruuden reittejä. Luo sisäänmuuttotarkastuksen sopimuksen id:llä. Jos sopimuksella on jo tarkastus, palauttaa sen Id:n.
GET asuntotarkastukset?Offset={Offset}&Limit={Limit}&Tarkastaja_id={Tarkastaja_id}&LoppuPvm={LoppuPvm} HUOM! Tämä reitti on vanhentunut, käytetään tarkastukset nimiavaruuden reittejä. Palauttaa tarkastajan uusien ja avattujen asuntotarkastusten tiedot sivutetusti.
GET asuntotarkastukset/tarkastajan?Offset={Offset}&Limit={Limit}&Tarkastaja_id={Tarkastaja_id}&LoppuPvm={LoppuPvm} HUOM! Tämä reitti on vanhentunut, käytetään tarkastukset nimiavaruuden reittejä. Palauttaa tarkastajan uusien ja avattujen asuntotarkastusten tiedot sivutetusti.
GET asuntotarkastukset/kohteen?Offset={Offset}&Limit={Limit}&Kohde_id={Kohde_id} HUOM! Tämä reitti on vanhentunut, käytetään tarkastukset nimiavaruuden reittejä. Palauttaa kohteen uusien ja avattujen asuntotarkastusten tiedot.
POST asuntotarkastukset/tallennatarkastus HUOM! Tämä reitti on vanhentunut, käytetään tarkastukset nimiavaruuden reittejä. Tallentaa asuntotarkastuksen. Asuntotarkastukselle voidaan lisätä myös ilmoituksia ja liitteitä.
POST asuntotarkastukset/tallennahuoneet HUOM! Tämä reitti on vanhentunut, käytetään tarkastukset nimiavaruuden reittejä. Tallentaa tarkastusta varten valitut huoneet ja palauttaa tarkastuksen.

Autopaikka

APIDescription
GET autopaikat?Kustannuspaikka_id={Kustannuspaikka_id}&Hakusana={Hakusana} Hae kustannuspaikan kaikki autopaikat tietoineen.
GET autopaikat/kustannuspaikan?Kustannuspaikka_id={Kustannuspaikka_id}&Hakusana={Hakusana} Hae kustannuspaikan kaikki autopaikat tietoineen.
GET autopaikat/asukkaan?osapuoli_id={osapuoli_id} Hae osapuolen kaikki autopaikat tietoineen
GET autopaikat/{autopaikka_id}/jonotukset Hae autopaikan suorat jonotukset
GET autopaikat/jonotukset?kustannuspaikka_id={kustannuspaikka_id} Hae kustannuspaikan jonotukset
POST autopaikat/sopimukset Lisää autopaikkasopimus (/varaus)
POST autopaikat/sopimukset/{sopimus_id}/paata Päätä olemassa oleva autopaikkasopimus.
POST autopaikat/jonotukset Lisää uusi autopaikkajonotus
DELETE autopaikat/jonotukset/{jonotus_id} Poista autopaikkajonotus
GET autopaikat/asetukset Hae autopaikkojen asetukset

Avainhallinta

APIDescription
GET avainluovutussopimukset/{sopimus_id} Palauttaa avainluovutussopimuksen id:llä.
GET avainluovutussopimukset/kohde/{kohde_id}/luovuttaja/{luovuttaja_id}/ehdotelmat
GET avainluovutussopimukset/vastaanottaja/{vastaanottaja_id}/ehdotelmat
POST avainluovutussopimukset
GET avainluovutussopimukset/vastaanottaja/{vastaanottaja_id}
GET avainluovutussopimukset/luovuttaja/{luovuttaja_id}
GET avainluovutussopimukset/kohde/{kohde_id}?Offset={Offset}&Limit={Limit}
GET avainluovutussopimukset/{sopimus_id}/avaimet
GET avainlainaukset/lainaaja/{lainaaja_id}?palautetut={palautetut} Palauttaa voimassa olevat lainaukset lainaajalla.
GET avainhallinta/lainaukset/niput/{nippuId} Palauttaa yhteen lainaustapahtumaan kuuluvat lainaukset
POST avainlainaukset/paata Päättää avainlainat
POST avainlainaukset/{laina_id}/palauta Asettaa avaimen palautetuksi
GET avainlainaukset/huoneisto/{huoneisto_id} Hakee huoneiston lainassa olevat avaimet
GET avainlainaukset/osapuoli/{osapuoli_id} Hakee osapuolen lainassa olevat avaimet
POST avainlainaukset/osapuolet Hakee osapuolien lainassa olevat avaimet
POST avainhallinta/lainaukset/{id}/paivita Päivittää avainlainauksen
POST avaintilaukset/kohde/{kohde_id}/hae Hakee kohteen avain- tai avainsarjatilaukset
GET avainhallinta/lainaukset/{id} Hakee avainlainan id:n perusteella
POST avainhallinta/avaimet/lisaa Lisää avaimen
GET avainhallinta/avainsarjat/{id} Hakee avainsarjan id:n perusteella
POST avainhallinta/avainsarjat/lisaa Lisää avainsarjan
GET avainhallinta/avaimet/{id} Hakee avaimen yksilöllisen id:n perusteella

AvainhallintaNoutoautomaatti

APIDescription
GET avainhallinta/lainaukset/noutoautomaatti/niput/{id} Hakee noutoautomaatin lainauksen Id:llä
POST avainhallinta/lainaukset/noutoautomaatti/niput/{id}/saapunut Vaihtaa lainaustapahtuman tilan ja asettaa aikaleiman, kun avaimet laitetaan automaattiin
POST avainhallinta/lainaukset/noutoautomaatti/niput/{id}/noudettu Vaihtaa lainaustapahtuman tilan ja asettaa aikaleiman, kun avaimet noudetaan automaatista
POST avainhallinta/lainaukset/noutoautomaatti/niput/{id}/paivita Päivittää lainaustapahtuman tietoja
POST avainhallinta/lainaukset/noutoautomaatti/niput/{id}/peruttu Vaihtaa lainaustapahtuman tilan ja asettaa aikaleiman, kun avaimet poistetaan automaatista

Dokumenttipankki

Dokumenttipankin toiminnot

APIDescription
POST dokumenttipankki/liitteet/lisaa Lisää liitteen annettuun kansioon
GET dokumenttipankki/liitteet/kategoriat Palauttaa dokumenttipankin liitekategoriat.
GET dokumenttipankki/liitteet/{id} Lataa liitteen uusimman tiedoston.
DELETE dokumenttipankki/liitteet/{id} Poistaa dokumenttipankin liitteen ja sen tiedostot
GET dokumenttipankki/liitteet/selaa?KohdeId={KohdeId}&Liitetyypit={Liitetyypit}&Julkinen={Julkinen}&Hakusana={Hakusana}&Sort={Sort}&Order={Order}&Offset={Offset}&Limit={Limit} Hakee kohdekansion alla olevat liitteet hakuparametrien määritysten mukaan
GET dokumenttipankki/liitteet/yleiset/selaa?Kategoriat={Kategoriat}&Kansio={Kansio}&Offset={Offset}&Limit={Limit} Hakee liitteet valitun kansion ja kategorian mukaan
POST dokumenttipankki/liitteet/kohteet/{kohdeId}/selaa Palauttaa kohteen ja kaikkien sen alikohteiden liitteet annetuilla parametreillä
POST dokumenttipankki/liitteet/kohteet/{kohdeId}/naytettavat/selaa Palauttaa näkyvyysasetuksin rajatusti tai kaikki julkiset dokumentit kustannuspaikan alla olevista kansioista.
PATCH dokumenttipankki/liitteet/{liiteId}/update Päivittää liitteen tietoja
POST dokumenttipankki/liitteet/{liiteId}/uusiversio Päivittää liitteelle uuden tiedoston

EtupisteetOsapuoliTapahtuma

APIDescription
GET etupisteet/osapuolet/{osapuoliId}/tapahtumat Hakee osapuolen tapahtumat

EtupisteetTapahtumaTyyppi

APIDescription
GET etupisteet/tapahtumatyypit Hakee tapahtumatyypit

Hakemus

Toiminnot hakemusten käsittelyyn ja hakuihin

APIDescription
GET hakemukset/{hakemusId} Palauttaa hakemuksen tiedot
GET hakemukset?osapuoli_id={osapuoli_id} Palauttaa yhteenvedot osapuolen voimassa olevista hakemuksista.
GET hakemukset/{hakemus_id}/liitteet/selaa Palauttaa hakemuksen liitteet.
POST hakemukset/{hakemus_id}/laskevastaavienlukumaara Laskee saman kohdistuksen omaavien aktiivisten hakemusten lukumäärän
POST hakemukset Lisää uuden hakemuksen
GET hakemukset/lomakevalinnat Hakee Hakemuslomakkeen valinnat
POST hakemukset/{hakemus_id}/uudista Uudistaa hakemuksen
POST hakemukset/{hakemus_id}/vanhenna Vanhentaa hakemuksen
PATCH hakemukset/{hakemusId}/paivita Päivittää hakemusta annettujen parametrien mukaan.
PATCH hakemukset/{hakemusId}/osapuolet/{osapuoliId}/paivita Päivittää hakemuksen osapuolta annettujen parametrien mukaan.
POST hakemukset/{hakemus_id}/liitteet/lisaa Lisää uuden liitteen hakemukselle.
GET hakemukset/{hakemus_id}/tiedostot/{tiedosto_id}/lataa Palauttaa hakemuksen liitetiedoston pyydettäessä tiedoston id:llä.
POST hakemukset/{hakemus_id}/tila/paivita Päivittää hakemuksen tilan jos: Päivitettävä tila on tunnettu Hakemus on olemassa Hakemuksen tila ei ole poistettu, hylätty tai sopimuksella.

Huoltokalenteri

Huoltokirjan palvelut

APIDescription
GET huoltokirja/huoltokalenteri?KohdeId={KohdeId}&Vuosi={Vuosi} Hakee huoltokalenterin annettujen kyselytietojen perusteella.

Huoltotehtava

Tarjoaa huoltotehtävien palveluita.

APIDescription
GET huoltotehtava?id={id} Etsii huoltotehtävän Id:llä, palauttaa tyhjän jos sellaista ei löydy.
GET huoltotehtava?tyonsuorittaja_id={tyonsuorittaja_id} Etsii työnsuorittajan huoltotehtävät, jos niitä ei ole palauttaa tyhjän kokoelman.
POST huoltotehtava/{id}/kuittaa Kuittaa huoltotehtävän suoritetuksi
GET huoltotehtava/mallitehtavat/{id} Hakee mallitehtävän Id:llä

Ilmoitukset

APIDescription
GET ilmoitukset/{id} Palauttaa ilmoituksen täydet tiedot.
GET ilmoitukset/{id}/minimal Palauttaa pienimmät ilmoituksen tiedot.
POST ilmoitukset/selaa Hakee sivutetusti joukon ilmoituksia parametreillä.
GET ilmoitukset/toimijan?Offset={Offset}&Limit={Limit}&Tila={Tila}&Kiireellisyys={Kiireellisyys} Hakee kaikki yrityksen ilmoitukset sivutetusti.
GET ilmoitukset/{id}/aliilmoitukset?Offset={Offset}&Limit={Limit} No documentation available.
POST ilmoitukset/omatkohteet/selaa Hakee kaikki käyttäjän kohteiden ilmoitetut sivutestusti.
GET ilmoitukset/asetukset Hakee ilmoitushallinnan asetukset
GET ilmoitukset/statusevent/{id} Palauttaa tilamuutoksen tiedot.
POST ilmoitukset/lisaa Luo uuden ilmoituksen ja palauttaa sen id:n.
PATCH ilmoitukset/{id} Päivittää ilmoituksen tietoja JSON-patch
GET ilmoitukset/{id}/laskutustiedot Hakee ilmoituksen laskutusitiedot
GET ilmoitukset/{id}/ulkokuittaustiedot Hakee ilmoituksen ulkokuittauksessa näytettävät tiedot
GET ilmoitukset/ilmoittajat?kohteenId={kohteenId}&Offset={Offset}&Limit={Limit} Hakee ilmoittajat kohdeId:n perusteella.

Ilmoitus

Ilmoitusten hakuun ja luontiin tarkoitetut toiminnot

APIDescription
GET ilmoitukset?kohde_id={kohde_id} HUOM!!!Tämä metodi on deprekoitu ja se poistuu käytöstä. Palauttaa kokoelman ilmoituksia, jotka ovat kytketty annettuun kohteeseen. Kohde voi olla kustannuspaikka, huoneisto tai tila.
GET ilmoitukset/kohteella?Limit={Limit}&Offset={Offset}&Kohde_id={Kohde_id}&Julkinen={Julkinen}&VainKustannuspaikan={VainKustannuspaikan}&Vikaluokat={Vikaluokat}&Tila={Tila}&Kohdetyypit={Kohdetyypit}&Order={Order} Palauttaa kokoelman ilmoituksia, jotka ovat kytketty kustannuspaikkaan.
GET ilmoitukset?solu_id={solu_id} Palauttaa kokoelman ilmoituksia, jotka ovat kytketty annettuun soluun.
POST ilmoitukset/{ilmoitus_id}/kuittaatehdyksi Kuittaa ilmoituksen tehdyksi
POST ilmoitukset/{ilmoitus_id}/kuittaavalmiiksi Kuittaa ilmoituksen valmiiksi
POST ilmoitukset/{ilmoitus_id}/vastaanota Ilmoituksen kuittaaminen vastaanotetuksi
POST ilmoitukset/{ilmoitus_id}/odotukseen Ilmoituksen kuittaaminen odotukseen
POST ilmoitukset/{ilmoitus_id}/laskutukseen Ilmoituksen kuittaaminen laskutukseen
POST ilmoitukset/{ilmoitus_id}/hyvaksyntaan Ilmoituksen siirtäminen hyväksyntään.
POST ilmoitukset/{ilmoitus_id}/poista Merkkaa ilmoituksen poistetuksi. Ilmoitus jää tietokantaan.
POST ilmoitukset/base64 Lisää ilmoituksen. Paketti pitää sisällään ilmoituksen perusosuuden [Ilmoitus] ja taulukon ilmoituksen liitteistä [Liitteet]. Kumman tahansa tiedon puuttuminen nostaa virheen 400 Bad Request. Mikäli liitteitä ei toimiteta kuuluu taulukon olla tyhjä. Liitteitä voi toimittaa useita. Liitteen tiedot ovat merkkijonoja ja Base64Content on liitetiedoston sisältö Base64 muotoisena. Ilmoitukselle pitää olla määritettynä joko työntekijäyritys tai kysymyspatterikysymys, mutta vain toinen niistä. Virhekoodit: 104 - Kysymyspatterin osoittama työnsuorittaja puuttuu: Kohteelta ei löydy kysymyspatterin osoittaman roolin mukaista yhteyttä.
POST ilmoitukset/nettilomakkeet/{nettilomake_id}/kohteet Palauttaa ilmoitushallinnan nettilomakkeen kohteet halutuilla parametreillä
GET ilmoitukset/{ilmoitus_id}/liitteet Hakee ilmoituksen liitteiden tiedot
GET ilmoitukset/liitteet/{liite_id} Hakee ilmoituksen liitteiden tiedot
POST ilmoitukset/{ilmoitus_id}/lisatiedot Päivittää ilmoituksen tietoja
GET ilmoitukset/lomakevalinnat?Kielet={Kielet} Huomio! Käytä lomakevalinnat kokoelmaa, Kiireellisyys, Kotielaimet, Sisaanpaasy, Vikaluokka string-kokoelmat tulevat poistumaan. Palauttaa Ilmoituslomakkeen valintalistat Accept-Language headerillä voi pyytää myös tiettyä kieltä
POST ilmoitukset/{ilmoitus_id}/liitteet/lisaa Lisää liitteitä ilmoitukselle
POST ilmoitukset/{ilmoitus_id}/sahkoposti/laheta Lähettää ilmoitukseen liittyvän viestin valituille ilmoituksen kustannuspaikan osapuolille.

Ilmoituskommentti

Tarjoaa ilmoituksen kommenttien palveluita.

APIDescription
GET ilmoitukset/{ilmoitusId}/kommentit?tyyppi[0]={tyyppi[0]}&tyyppi[1]={tyyppi[1]} Palauttaa kokoelman ilmoitukselle liitetyistä kommenteista.
GET ilmoitukset/kommentit/{kommenttiId} Palauttaa yksittäisen kommentin id:n perusteella.
POST ilmoitukset/{ilmoitusId}/kommentit/lisaa Lisää uuden kommentin ilmoitukselle
POST ilmoitukset/{ilmoitus_id}/kommentit/tilat Merkitsee ilmoituksen kommentit luetuksi ja lukemattomaksi

IlmoitusLoki

APIDescription
GET ilmoitukset/{ilmoitus_id}/loki?Offset={Offset}&Limit={Limit} Palauttaa ilmoituksen lokitietoja sivutestusti
POST ilmoitukset/viestiloki/lisaa Lisää merkinnän viestilokiin
GET ilmoitukset/{ilmoitus_id}/viestiloki/selaa?Offset={Offset}&Limit={Limit} Palauttaa ilmoituksen lähetyslokitietoja sivutestusti

IlmoitusTuote

APIDescription
GET ilmoitukset/{id}/tuotteet Palauttaa ilmoitukselle lisätyt tuotteet
POST ilmoitukset/{id}/tuotteet/lisaa Lisää tuotteet ilmoutukselle

IlmoitusValinnat

Ilmoitusten valinnat

APIDescription
GET ilmoitukset/kohteen/{kohde_id}/tyonsuorittajat Palauttaa ilmoituksen työnsuorittajien valinta listat.

KayttopaivakirjaKommentti

APIDescription
GET kayttopaivakirja/merkinnat/{id}/kommentit Hakee käyttöpäiväkirjan merkinnän kommentit
POST kayttopaivakirja/merkinnat/{id}/kommentit/lisaa Lisää käyttöpäiväkirjan merkinnän kommentin

KayttopaivakirjaLiite

APIDescription
GET kayttopaivakirja/merkinnat/{id}/liitteet Hakee käyttöpäiväkirjan merkinnän liitteet
GET kayttopaivakirja/liitteet/{id}/tiedosto Hakee liitteen uusimman tiedoston.
POST kayttopaivakirja/merkinnat/{id}/liitteet/lisaa Lisää käyttöpäiväkirjan merkinnälle liitteen

KayttopaivakirjaMerkinta

APIDescription
GET kayttopaivakirja/merkinnat/{id} Hakee yhden käyttöpäiväkirjamerkinnän
POST kayttopaivakirja/merkinnat/search Hakee Käyttöpäiväkirjamerkinnät hakuehdoilla.
POST kayttopaivakirja/merkinnat/add Lisää käyttöpäiväkirjamerkinnän.
POST kayttopaivakirja/merkinnat/{id}/update Päivittää käyttöpäiväkirjamerkinnän
POST kayttopaivakirja/merkinnat/{id}/ilmoitukset/{ilmoitusId}/add Päivittää ilmoituksen Id:n käyttäpäiväkirjan merkinnälle.
DELETE kayttopaivakirja/merkinnat/{id}/delete Poistaa käyttöpäiväkirjamerkinnän.

KayttopaivakirjaToimenpideluokka

APIDescription
GET kayttopaivakirja/toimenpideluokat Hakee Käyttöpäiväkirjojen toimenpideluokat.

KihlaKeskustelu

APIDescription
POST kihla/keskustelut/search Hakee keskusteluja määrätyillä parametreillä.

KihlaKommentti


KihlaMallipohja

APIDescription
GET kihla/teknisettarkastukset/mallipohjat Palauttaa kaikki teknisten tarkastusten mallipohjat.

KihlaOsapuoli

APIDescription
GET kihla/osapuolet/tarkastajat/search?Hakusana={Hakusana} Palauttaa kihlan tarkastajaosapuolet.

KihlaPäivittäisseuranta

APIDescription
GET kihla/paivittaisseurannat/{id} Hakee päivittäisseurannan id:llä
POST kihla/paivittaisseurannat/search Hakee päivittäisseurannat hakuehdoilla.

KihlaTarkastelukierros

APIDescription
GET kihla/tarkastelukierrokset Palauttaa kaikki tarkastelukierrokset.


KihlaTekninenTarkastus

APIDescription
GET kihla/teknisettarkastukset/{id} Hakee teknisen tarkastuksen id:llä
GET kihla/paivittaisseurannat/{paivittaisseurantaId}/teknisettarkastukset Hakee teknisiä tarkastuksia päivittäisseuranta id:llä.
POST kihla/paivittaisseurannat/{id}/teknisettarkastukset/add Lisää kierroksen päivittäisseurannalle.
POST kihla/teknisettarkastukset/search Hakee Tekniset tarkastukset hakuehdoilla.
POST kihla/teknisettarkastukset/{id}/valmiiksi Asettaa teknisen tarkastuksen valmiiksi.
POST kihla/teknisettarkastukset/{id}/tyonalle Asettaa teknisen tarkastuksen työn alle.
POST kihla/teknisettarkastukset/{id}/update Päivittää tarkastuksen annetuilla parametreilla.

Kirjaukset

APIDescription
GET kirjaukset/ilmoitus/{ilmoitusid}/kirjaukset Hakee ilmoituksen kirjaukset
GET kirjaukset/ilmoitus/{ilmoitusid}/hyvaksytyt Hakee ilmoituksen hyväksytyt kirjaukset
POST kirjaukset/ilmoitus/{ilmoitusid}/kirjaus/lisaa Lisää kirjauksen
PATCH kirjaukset/kirjaus/{kirjausid}/paivita Päivittää kirjauksen tietoja
DELETE kirjaukset/kirjaus/{kirjausid}/poista Poistaa kirjauksen jos sitä ei ole hyväksytty

Kohde

APIDescription
GET kohteet/{kohde_id} Hakee kohteen id:llä ja palauttaa kaikki sille tallennetut tiedot.
GET kohteet?ids[0]={ids[0]}&ids[1]={ids[1]} Hakee kohteita ja palauttaa kaikki niille tallennetut tiedot.
PUT kohteet/{kohde_id} Päivitä kohteen tietoja metatietojen perusteella
POST kohteet/{kohde_id} Päivitä kohteen tietoja metatietojen perusteella
GET kohteet/metanimet Hae kohteen kenttien metanimet
GET kohteet/{kohde_id}/saunat Hae kohteen saunat
GET kohteet/{kohde_id}/maksutiedot Hae kohteen omistajan maksutiedot
GET kustannuspaikat?Metanimet={Metanimet}&Offset={Offset}&Limit={Limit}&Hakusana={Hakusana}&Tasmalleen={Tasmalleen} Hakee kustannuspaikat sivutetusti, vaihtoehtoisesti hakusanalla suodatettuna.
GET kustannuspaikat/selaa?Metanimet={Metanimet}&Offset={Offset}&Limit={Limit}&Hakusana={Hakusana}&Tasmalleen={Tasmalleen} Hakee kustannuspaikat sivutetusti, vaihtoehtoisesti hakusanalla suodatettuna.
GET kustannuspaikat/{kustannuspaikka_id}/{metatyyppi}?Metanimet={Metanimet} Hae kohteen alakohteet
GET kustannuspaikat/{kustannuspaikka_id}/tilat?hakusana={hakusana} Hakee kustannuspaikan tilat
POST kohteet/liitteet/lisaa Lisää liitteen kohteelle
DELETE kohteet/liitteet/{liite_id} Poistaa kohderekisterin liitteen ja sen tiedostot
POST kohteet/{kohde_id}/osapuolet/{osapuoli_id}/yhteys/paata Päättää yhteyden osapuolen ja kohteen väliltä annetun metanimen perusteella annettuun päivämäärään. Tuetut metanimet voi hakea routella: GET osapuolet/roolit/metanimet
POST kohteet/{kohde_id}/selaa Hakee kohteen ja sen alla olevat alikohteet. Jos AlikohteenMetaTyypit on null tai tyhjä niin oletuksena haetaan Rakennus, Huoneisto,Liikehuoneisto, Huone sekä Vuodepaikka tyypeillä.
GET kohteet/huoneistotyypit/hae Palauttaa kaikki huoneistotyypit.
GET kustannuspaikat/omat Käyttäjän kustannuspaikat(Eli on oikeus kp:aan ja on sillä voimassa olevalla yhteydellä jollakin roolilla).
GET kohteet/{kohdeId}/linkit Palauttaa kohteen linkit.

KohdeAsukastieto

Kohteiden asukastietojen käsittelyn rajapinnat.

APIDescription
GET kohteet/{kohde_id}/asukkaat?Offset={Offset}&Limit={Limit}&Hakusana={Hakusana} Hae kaikki asukkaat kohteessa tai sen lapsilla. Korjattu v8 rajapinnasta alkaen sivutus, offset oli aikasemmin virheellisesti sivunumero.
GET kohteet/{kohde_id}/asukkaat/tulevat?Offset={Offset}&Limit={Limit}&Hakusana={Hakusana} Hae kaikki tulevat asukkaat kohteessa tai sen lapsilla.

KohdeCreateApi

APIDescription
POST kohteet/kustannuspaikka/create Lisää kustannuspaikka tyyppisen kohteen perustiedoilla
POST kohteet/tontti/create Lisää tontti tyyppisen kohteen perustiedoilla
POST kohteet/rakennus/create Lisää rakennus tyyppisen kohteen perustiedoilla
POST kohteet/huoneisto/create Lisää huoneisto tyyppisen kohteen perustiedoilla
POST kohteet/ryhma/create Lisää ryhmä tyyppisen kohteen perustiedoilla
POST kohteet/huone/create Lisää ryhmä tyyppisen kohteen perustiedoilla

KohderekisteriHistoria

Kohderekisterin historiatietojen rajapinta.

APIDescription
GET kohteet/muuttuneet/selaa?Alkaa={Alkaa}&Paattyy={Paattyy}&Offset={Offset}&Limit={Limit} Palauttaa annetulla aikavälillä muuttuneet kohteet.

Kohdevaruste

Kohteen varusteet ovat sellaisia asioita kuin "Pakastin", "Jääkaappi" jne.

APIDescription
GET kohteet/{kohde_id}/varusteet Palauttaa kohteen varusteet. Haku palauttaa korkeintaan 50 varustetta.
GET kohteet/varusteet/{varuste_id} Palauttaa varusteen annetulla id:llä.
GET kohteet/varusteet/liitteet/{liite_id} Palauttaa varusteen liiteen sisällön.

KoosteetOsapuolitiedot

APIDescription
POST koosteet/osapuolitiedot/sopimustiedot/hae Palauttaa osapuolen sopimusten tietoja koottuna useasta palvelusta.

KulutusseurantaKohdeKuukausikulutus

APIDescription
POST kulutusseuranta/kulutukset/kuukausikulutus Palauttaa hakuehtojen mukaisia kohteiden kuukausikulutustietoja

KulutusseurantaKohdePäiväkulutus

APIDescription
POST kulutusseuranta/kulutukset/paivakulutus Palauttaa hakuehtojen mukaisia kohteiden päiväkulutustietoja

KulutusseurantaKohdeSeurantalaji

APIDescription
POST kulutusseuranta/seurantalajit/kohdeseurantalajit Palauttaa hakuehtojen mukaisten kohteiden seurantalajit.

KulutusseurantaKohdeTuntikulutus

APIDescription
POST kulutusseuranta/kulutukset/tuntikulutus Palauttaa hakuehtojen mukaisia kohteiden tuntikulutustietoja

KulutusseurantaKohdeVuosikulutus

APIDescription
POST kulutusseuranta/kulutukset/vuosikulutus Palauttaa hakuehtojen mukaisia kohteiden vuosikulutustietoja

KulutusseurantaMittari

APIDescription
GET kulutusseuranta/kohteet/{kohdeId}/mittarit Palauttaa kohteen käytössä olevat mittarit.

KulutusseurantaMittariLukema

APIDescription
GET kulutusseuranta/mittarit/{mittariId}/lukemat/uusin Hakee mittarin uusimman lukeman. Palauttaa NULL jos yhtään lukemaa ei ole.
GET kulutusseuranta/mittarit/{mittariId}/lukemat/uusinkulutus Hakee mittarin viimeisimmän kulutuksen.
GET kulutusseuranta/mittarit/{mittariId}/lukemat/{lukemaPvm}/validations Hakee uuteen mittarilukemaan liittyvät validoinnit.
POST kulutusseuranta/mittarit/{mittariId}/lukemat/save Mittarilukeman lisäys ja muokkaus Lukemaa muokataan, jos mittariId ja lukeman päivämäärä vastaavat aikaisempaa lukemaa.

KulutusseurantaSeurantalaji

APIDescription
GET kulutusseuranta/seurantalajit Palauttaa kaikki seurantalajit.

Kysymyspatteri

Kysymyspatterin kysymysten hakuun hakuun tarkoitetut toiminnot

APIDescription
GET kysymyspatterit?Type={Type}&KohdeId={KohdeId} Palauttaa kokoelman kysymyspatterin kysymyksiä, jotka ovat kytketty tiettyyn prosessiin(tyyppiin). Asetuksista riippuen palauttaa kysymykset joko kohdekohtaisesti tai yleisesti, eli kaikki kysymykset.

Laina

Lainarekisteri

APIDescription
POST lainat/{lainanumero}/tapahtuma/lisaa Lisää lainalle tapahtuman. Laina haetaan lainanumerolla. Lainanumerolla tulee löytyä vain yksi tilaltaan aktiivinen laina. Aktiiviset tilat ovat: Ei asetettu, Suunnitteilla, Hallituksen esitys, Hyväksytty, Osa nostettu, Nostettu
DELETE lainat/tapahtumat/{tapahtuma_id} Poistaa lainatapahtuman.
GET lainat/kohteet/{huoneisto_id}/aktiivisetlainat/hae?tilannepvm={tilannepvm} Hakee osakkaan (kohdehuoneiston) aktiiviset lainat sekä saldot annetun tilannepäivän mukaan. Mukaan otetaan lainat, joiden tilat ovat: Ei asetettu, Osa nostettu, Nostettu

Lasku

Toiminnot laskujen hakuihin

APIDescription
GET erillislaskut?sopimus_id={sopimus_id}&alkupvm={alkupvm}&loppupvm={loppupvm} Hakee erillislaskut annetulta aikaväliltä sopimus id:llä

Maksulaji

APIDescription
GET maksulajit/kohteet?kohde_id={kohde_id} Hakee annetun kohteen maksulajit.
GET maksulajit/kohteet?kohde_id={kohde_id}&voimassa={voimassa} Hakee annetun kohteen maksulajit ja niiden annettuna päivänä voimassa olevan hinnan.
POST maksulajit/{maksulaji_id}/liitakohteelle?kohde_id={kohde_id} Lisää maksulajin kohteelle. Hinta lisätään kohteelle maksulajin voimassa olevan hinnan mukaan. Jos kohdetta tai maksulajia ei löydy palautetaan virhe. Jos maksulaji on jo kohteella palutetaan virhe.
POST maksulajit/{maksulaji_id}/tariffit/lisaakohteelle?kohde_id={kohde_id} Lisää kohteen maksulajille tariffin eli yksikköhinnan. Veloituskuukaudet laitetaan lisättävälle tariffille oletuksena kaikki päälle. Samalle päivälle ei voi lisätä toista tariffia ja sellaisessa tapauksessa palautetaan virhe. Jos kohdetta tai kohdemaksulajia ei löydy palautetaan virhe.

Muutostyö

Osakkaan muutostöiden toiminnot

APIDescription
GET legacy/muutostyot/kustannuspaikka/{kohde_id}/osapuoli/{osapuoli_id}/hae Hakee kustannuspaikan osakkaan huoneistojen muutostyöt
GET legacy/muutostyot/{muutostyo_id}/hae Hakee muutostyön perustiedot, muutostyöehdotukset, muutostyön hyväksynnät sekä muutostyön kommentit sekä liitteiden metatiedot.
POST legacy/muutostyot/lisaa Lisää uuden muutostyöehdotuksen
POST legacy/muutostyot/lisaakommentilla Lisää uuden muutostyöehdotuksen kommentilla sekä tiedottaa sidosryhmia
POST legacy/muutostyot/{muutostyoilmoitus_id}/lisatiedot/toimita Päivittää muutostyön ajankohtaa, lisätään kommentti sekä liitteet. Lopuksi päivittää muutostyön tilaa.
POST legacy/muutostyot/{muutostyoilmoitus_id}/kommentit/lisaa Lisää uuden kommentin muutostyölle.
POST legacy/muutostyot/{muutostyoilmoitus_id}/kommentit/{muutostyoilmoitus_kommentti_id}/liitteet/lisaa Lisää uuden muutostyön kommentille liitteen.
GET legacy/muutostyot/vaihtoehdot/hae Hakee muutostöiden luokat ja niiden vaihtoehdot
GET legacy/muutostyot/liitteet/{liite_id} Hakee muutostyön liitteen tiedoston
GET legacy/muutostyot/asetukset Hakee muutostyön jättämiseen liittyvät asetukset.

Muutto

APIDescription
GET muutot/lomakevalinnat Palauttaa muuton mahdolliset valinnat.

Osakerekisteri

APIDescription
GET osakerekisteri/osakesarjat/{sisäinenTunnus}/hae Hakee osakesarjan tiedot.
POST osakerekisteri/osakesarjat/{sisäinenTunnus}/omistaja/merkitse Asettaa osakesarjan osakkaat. Osakkaita voi merkitä vain siinä tapauksessa, että osakesarjalla on jäljellä vapaata osuutta. Lisäosuuksien hankkiminen on tehtävä kaupan merkitsemisen kautta. Osakesarjan puuttuminen aiheuttaa virhekoodin 404.
POST osakerekisteri/osakesarjat/{sisäinenTunnus}/kauppa/merkitse Merkitsee uusia kauppoja. Mikäli sama osapuoli toimii kaupassa sekä myyjänä, että ostajana jätetään häntä koskevat ostamismerkinnät huomioimatta. Osakesarjan puuttuminen aiheuttaa virhekoodin 404.
POST osakerekisteri/osakesarjat/{sisäinenTunnus}/pvmtiedot/paivita Tallentaa omistajat-tauluun osakesarjan kauppoihin liittyviä päivämäärätietoja. Osakesarjan puuttuminen aiheuttaa virhekoodin 404.
GET osakerekisteri/kustannuspaikat/{kustannuspaikkaId}/osakesarjat?Offset={Offset}&Limit={Limit}&Sort={Sort}&Order={Order} Hakee kustannuspaikan osakesarjat sivutetusti

Osapuoli

APIDescription
POST osapuolet/{osapuoli_id} Päivitä osapuolen tietoja metatietojen perusteella
PUT osapuolet/{osapuoli_id} Päivitä osapuolen tietoja metatietojen perusteella
POST osapuolet/henkilot Lisää henkilöosapuoli
GET osapuolet/henkilot?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen} Palauttaa kokoelman henkilöitä, joiden määrätty parametri vastaa annettuun hakusanaan. Henkilöillä on "Parametrit"-kokoelma, mutta kokoelma on aina tyhjä.
GET osapuolet/yritykset?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen} Palauttaa kokoelman yritysosapuolia, joiden määrätty parametri vastaa annettuun hakusanaan. Henkilöillä on "Parametrit"-kokoelma, mutta kokoelma on aina tyhjä.
GET osapuolet?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen} Palauttaa kokoelman osapuolia, joiden määrätty parametri vastaa annettuun hakusanaan.
GET osapuolet/henkilot/selaa?Metanimet={Metanimet}&Limit={Limit}&Offset={Offset} Selaa henkilöitä, vastaus sivutetusti.
GET osapuolet/yritykset/selaa?Metanimet={Metanimet}&Limit={Limit}&Offset={Offset} Selaa yrityksiä, vastaus sivutetusti.
POST osapuolet/yritykset Lisää yritysosapuoli
GET osapuolet/metanimet Hae osapuolen kenttien metanimet
GET osapuolet/{osapuoli_id} Hae osapuoli osapuolen Id:llä
GET osapuolet/yhteydet/selaa?OsapuoliId={OsapuoliId}&KohdeId={KohdeId}&RooliId={RooliId}&Roolit={Roolit}&Tilannepaiva={Tilannepaiva} Hae osapuolien yhteydet osapuolen Id:llä
GET osapuolet/lomakevalinnat Hakee osapuolien metanimelliset lomakevalinnat
GET osapuolet/roolit/metanimet Hakee kaikki tunnetut osapuoliroolien metanimet
GET osapuolet/prosessin/{prosessi}/{henkilotunnus} No documentation available.
GET osapuolet/yrityksen/tyontekijat Hakee kaikki käyttäjän yrityksen työntekijät
GET osapuolet/yritykset/{yritys_id}/tyontekijat Hakee kaikki yrityksen työntekijät
GET osapuolet/kayttooikeusrooli/{rooli_id}?metanimet[0]={metanimet[0]}&metanimet[1]={metanimet[1]} Hakee käyttöoikeusroolilla olevat osapuolet

OsapuoliApi

Määrittelemättömiä osapuolia hallinnoiva kontrolleri. Yritysten toimintoja käsitellään yrityksiin erikoistuneessa YritysApiController-luokassa. Henkilöiden toimintoja käsitellään yrityksiin erikoistuneessa HenkiloApiController-luokassa.

APIDescription
GET osapuolitiedot/osapuolet/{id} Hakee osapuolen id:llä.
POST osapuolitiedot/osapuolet/hakusana?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen} Palauttaa kokoelman osapuolia, joiden määrätty parametri vastaa annettuun hakusanaan. Osapuolilla on "Parametrit"-kokoelma, mutta kokoelma on aina tyhjä.
POST osapuolitiedot/osapuolet/{id}/update Päivittää osapuolen tietoja metatietojen perusteella.
POST osapuolitiedot/osapuolet/hae Hakee arkistoimattomat osapuolet id:illä ja parametrit niille metanimillä tai id:illä.
GET osapuolitiedot/osapuolet/{osapuoli_id}/huomiot/hae Hakee osapuolen huomiot.

OsapuoliOikeudet

APIDescription
GET osapuolet/oikeudet/all Palauttaa kaikki ne oikeudet jotka käyttäjälle on myönnetty.
GET osapuolet/oikeudet/user/{userId}/all Palauttaa kaikki ne oikeudet jotka käyttäjälle on myönnetty.

OsapuoliYhteydenotto

APIDescription
POST yhteydenotot Lisää osapuolen yhteydenoton
GET yhteydenotot?osapuoli_id={osapuoli_id} Palauttaa osapuolen yhteydenottojen tiedot
GET yhteydenotot/{yhteydenotto_id} Palauttaa yhteydentoton tiedot yhteydenottoidllä
GET yhteydenotot/liitteet/{liite_id} Palauttaa yhteydentoton liitteen.
POST yhteydenotot/{yhteydenotto_id}/asetaluetuksi?tunnus={tunnus} Asettaa yhteydenoton tilaan luettu.
POST yhteydenotot/{yhteydenotto_id}/asetakasitellyksi?tunnus={tunnus} Asettaa yhteydenoton tilaan käsitelty.
GET yhteydenotot/luokittelut Palauttaa listan yhteydenottojen luokittelu-vaihtoehdoista
GET yhteydenotot/viestiketjut/{viestiketju_id} Palauttaa listan yhteudenotoista viestiketjuid:n perusteella

Reskontra

APIDescription
GET reskontra/indeksit?tilannepvm={tilannepvm} Tilannepäivänä voimassaolevien indeksien haku. Tilannepäivää verrataan indeksin julkaisupäivään.

Saunavuoro

Saunavuorojen operaatiot.

APIDescription
GET saunavuorot/oletusasetukset Palauttaa saunavuorojen oletusasetukset.
GET saunavuorot/asetukset?sauna_id={sauna_id} Palauttaa saunavuoron asetukset.
GET saunavuorot/{saunavuoro_id} Hakee saunavuoron järjestelmästä.
POST saunavuorot Lisää uuden saunavuoron järjestelmään.
GET saunavuorot?kustannuspaikka_id={kustannuspaikka_id} Palauttaa varaukset varaajan kustannuspaikan perusteella.
GET saunavuorot/kustannuspaikka/{kustannuspaikka_id} Palauttaa varaukset varaajan kustannuspaikan perusteella.
GET saunavuorot/kustannuspaikka/varaukset/{kustannuspaikka_id} Palauttaa kustannuspaikan alla olevien kohteiden kaikki varaukset.
GET saunavuorot?kohde_id={kohde_id} Palauttaa kohteen kaikki varaukset.
GET saunavuorot/kohde/{kohde_id} Palauttaa kohteen kaikki varaukset.
GET saunavuorot?varaaja_kohde_id={varaaja_kohde_id} Palauttaa kohteen nimissä tehdyt saunavuorovaraukset.
GET saunavuorot/varaajakohde/{varaaja_kohde_id} Palauttaa kohteen nimissä tehdyt saunavuorovaraukset.
GET saunavuorot?varaaja_osapuoli_id={varaaja_osapuoli_id} Palauttaa henkilön nimissä tehdyt saunavuorovaraukset.
GET saunavuorot/varaaja/{varaaja_osapuoli_id} Palauttaa henkilön nimissä tehdyt saunavuorovaraukset.
DELETE saunavuorot/{saunavuoro_id} Poistaa saunavuoron järjestelmästä.
POST saunavuorot/{saunavuoro_id}/paata?loppuupvm={loppuupvm} Päättää saunavuoron tähän päivään

Sopimus

APIDescription
GET sopimukset/{sopimus_id} Hakee sopimuksen tiedot id:llä
GET sopimukset?tarjous_id={tarjous_id} Hakee listan sopimusten yhteenvedoista tarjous id:llä
GET sopimukset?henkilotunnus={henkilotunnus} Hakee listan sopimusten yhteenvedoista henkilötunnuksella
GET sopimukset?osapuoli_id={osapuoli_id} Hakee listan sopimusten yhteenvedoista osapuoli id:llä
GET sopimukset/{osapuoli_id}/irtisanottavat Palauttaa listan sopimusten yhteenvedoista osapuolen irtisanottavissa olevista sopimuksista.
POST sopimukset/{sopimus_id}/lisaapalvelu Lisää palvelun (esim. saunavuoron tai autopaikan) sopimukselle. Palvelun hinnan tulee löytyä kohteen maksulajeista.
POST sopimukset/{sopimus_id}/paatapalvelu Päättää palvelun (esim. saunavuoron tai autopaikan) sopimukselta.
GET sopimukset/{sopimus_id}/asuntotarkastukset Hae sopimukseen liittyvät asuntotarkastukset.
GET sopimukset/{sopimus_id}/liitteet?Liitekategoria={Liitekategoria} Hakee sopimuksen liitteet
GET sopimukset/{sopimus_id}/tiedostot/{tiedosto_id} Palauttaa sopimuksen liitetiedoston pyydettäessä tiedoston id:llä.
POST sopimukset/{sopimus_id}/liitteet/lisaa Lisää annetun tiedoston sopimuksen liitteeksi.
GET sopimukset/liitteet?Kustannuspaikka_id={Kustannuspaikka_id}&Liitekategoria={Liitekategoria} Hakee sopimuskategorian yleiset liitteet
GET sopimukset/tiedostot/{tiedosto_id}?kustannuspaikka_id={kustannuspaikka_id} Palauttaa sopimuksen yleisen liitetiedoston pyydettäessä tiedoston id:llä.
GET sopimukset/{sopimus_id}/saldo Palauttaa sopimuksen saldon kuun loppuun tavoitteiden päivien perusteella
GET sopimukset/{sopimusId}/saldo/erapvm?tilannepvm={tilannepvm} Palauttaa sopimuksen saldon annetulla päivällä tavoitteiden eräpäivän perusteella
GET sopimukset/irtisanomisilmoitukset?alkupvm={alkupvm} Hakee irtisanomisilmoituksia tietystä ajankohdasta lähtien.
POST sopimukset/{sopimus_id}/osapuolet Lisää asiakaspalvelusopimukselle uuden osapuolen. Esimerkiksi kun asuntoon muuttaa sopimusosapuolen puoliso, voidaan uuden sisäänmuuttavan henkilön tiedot lisätä sopimukselle tällä metodilla. Jos sopimukselle ei voi lisätä osapuolia sopimuksen tilasta johtuen tai sopimuksella on jo joku lisättävistä osapuolista niin toimintoa ei suoriteta ja palautetaan conflict (409).
POST sopimukset/{sopimus_id}/osapuolet/{osapuoli_id} Muokkaa osapuolen parametreja. Annetaan sen osapuolen parameterit joita halutaan muuttaa. Niitä mitä ei haluta muuttaa, ei tarvitse antaa. Jos osapuoli ei löydy sopimukselta, niin toimintoa ei suoriteta ja palautetaan virhe 400 bad request.
POST sopimukset/{sopimus_id}/paataosapuoli Päättää asiakaspalvelusopimuksen osapuolen kohdalta. Esimerkiksi kun asunnosta muuttaa yksi osapuoli pois, mutta muiden osapuolien sopimus säilyy, voidaan osapuolen maksuvelvoite päättää tällä metodilla. Jos osapuoli ei löydy sopimukselta, niin toimintoa ei suoriteta ja palautetaan virhe 400 bad request.
POST sopimukset/{sopimus_id}/poistaosapuoli Poistaa osapuolen sopimukselta kokonaan. Huom, yleensä osapuolta ei ole tarkoitus poistaa, vaan päättää. Poistaminen voi tulla kysymykseen virhetilanteessa, jossa osapuolta ei olisi kuulunut liittää sopimukselle alunperinkään. Jos osapuoli ei löydy sopimukselta, niin toimintoa ei suoriteta ja palautetaan virhe 400 bad request.
GET sopimukset/{sopimus_id}/vakuusmaksut Hakee listan sopimuksen vakuusmaksutiedoista
POST sopimukset/{sopimus_id}/vakuusmaksut/muutapalautustilinumero Päivittää sopimukselle vakuudenpalautustilinumeron ja päivittää palautustilinumeron myös vakuusmaksu suoritukselle mikäli vakuus on maksettu yhdessä erässä.
POST sopimukset/{sopimus_id}/hyvaksy Allekirjoittaa sopimuksen kyseisen osapuolen osalta
POST sopimukset/{sopimus_id}/hylkaa Muuttaa hankintaehdotuksen tilan hylätyksi.
GET sopimukset/{sopimus_id}/sopimusdokumentti Hakee sopimuksen uusimman sopimusdokumentin.
GET sopimukset/{sopimus_id}/vakuuslasku
POST sopimukset/{sopimus_id}/laskevuokra Laskee sopimuksen tilannepäivän mukaisen laskutuskauden vuokran
POST sopimukset/{sopimus_id}/allekirjoitus/valmis Muuttaa sopimuksen allekirjoituksen tilaksi Valmis ja asettaa sopimuksen allekirjoituksen päivämääräksi kuluvan päivän
POST sopimukset/{sopimus_id}/allekirjoitus/peruuta Muuttaa sopimuksen allekirjoituksen tilaksi Peruutettu ja poistaa sopimuksen allekirjoituksen päivämäärän. Sopimuksen allekirjoituksen tilan tulee olla Aloitettu tai Kesken jotta allekirjoituksen voi peruuttaa.
POST sopimukset/{sopimus_id}/allekirjoitus/kesken Muuttaa sopimuksen allekirjoituksen tilaksi Kesken. Sopimuksen allekirjoituksen tilan tulee olla Aloitettu jotta allekirjoituksen voi asettaan tilaan kesken.
GET sopimukset/allekirjoitettavat Hakee listan sähköisesti allekirjoitettavissa olevien sopimusten id:eistä Sopimukset joiden allekirjoituksen tila on Aloitettu ja joilla ei ole vielä allekirjoituspäivää
GET sopimukset/{sopimus_id}/irtisanomislomakevalinnat Hakee asukkaan sähköisen irtisanomisen lomakkeen valinnat
GET sopimukset/{sopimus_id}/perustiedot Etsii sopimuksen perustiedot, palauttaa nullin jos sopimusta ei löydy
POST sopimukset/{sopimus_id}/vakuuslasku/kuittaamaksetuksi Merkitsee sopimuksen vakuuslaskun maksetuksi
POST sopimukset/{sopimus_id}/irtisano Tallentaa sopimuksen irtisanomisen tiedot järjestelmään jatkokäsittelyä varten
POST sopimukset Luo järjestelmään uuden sopimuksen
POST sopimukset/{sopimus_id}/vakuuslasku Lisää vakuuslaskun sopimukselle
POST esisopimukset Luo järjestelmään uuden esisopimuksen
GET sopimukset/{sopimus_id}/suoritukset?AlkuPvm={AlkuPvm}&LoppuPvm={LoppuPvm} Palauttaa sopimuksen suoritukset (normaali ja palautus tyyppiset) annetulla aikavälillä
GET sopimukset/{sopimus_id}/maksulajit/hae Hakee sopimuksen maksulajit ja tariffit
POST sopimukset/{sopimus_id}/maksulajit/lisaa Lisää annetut maksulajit sopimukselle. Maksulaji ei saa olla sopimuksella ennestään ja sen täytyy olla voimassa jotta se voidaan lisätä. Vakuusmaksulajeja ei voi lisätä sopimukselle. Myöskään maksulajeja joille on määritelty kohdetyyppi ei voi lisätä tällä kutsulla.
POST sopimukset/{sopimus_id}/maksulajit/jyvittamaton/lisaa HUOM! suositellaan että käytetään POST sopimukset/{sopimus_id}/maksulajit/lisaa reittiä ensisijaisesti. Lisää annetut maksulajit sopimukselle. Vuosi maksulajilla ei jyvitä hintaa (yksikköhinta*veloitusperustekerroin) kuukausilla vaan lisää sen sellaisenaan. Maksulaji ei saa olla sopimuksella ennestään ja sen täytyy olla voimassa jotta se voidaan lisätä. Vakuusmaksulajeja ei voi lisätä sopimukselle. Myöskään maksulajeja joille on määritelty kohdetyyppi ei voi lisätä tällä kutsulla.
GET sopimukset/lomakevalinnat Palauttaa sopimuslomakkeen valintoja
POST sopimukset/{sopimus_id}/virkistatavoitteet Luo/päivittää sopimukselle sen maksulajeista tavoitteet ja luo ns. laskupohjat sopimukselle.
PATCH sopimukset/{sopimus_id} Päivittää sopimusta annettujen parametrien mukaan. Päivitetty sopimus validoidaan kokonaisuutena. Tämä kutsu ei automaattisesti päivitä muuta kuin sopimusta. Esim. sopimuksen alkupäivää muokattaessa on päivitettävä asukashallinta omalla kutsullaan.
POST sopimukset/{sopimus_id}/paatasopimus Päättää sopimuksen annettujen parametrien mukaan. Jos Yhteystiedot parametria ei ole annettu jätetään uudet yhteystiedot sopimuksella entiselleen. Muussa tapauksessa tallennetaan yhteystiedot annettuina.
POST sopimukset/{sopimus_id}/irtisanominen/luomuutto Lisää ulosmuuton sopimukselle.
POST sopimukset/{sopimusId}/asukkaat/kohdeyhteydet/luo Lisää sopimuksen asukkaille kohdeyhteydet ja päivittää ne sopimuksen osapuoli tauluun jos niitä ei vielä ole.
POST sopimukset/{sopimus_id}/maksulajit/{maksulaji_id}/uudelleen/kytke Uudelleen kytkee maksulajin sopimukselle. Jotta maksulajin voi uudelleen kytkeä sen pitää olla päätetty. Maksulaji kytketään uudelleen sellaisenaan. Uudelleen kytkeminen tehdään annetun alkupäivämäärän kuun ensimmäisestä päivästä lähtien. Jos yrittää uudelleen kytkeä maksulajia kausille jolla on muutoksenestettyjä (käsinsyötettyjä) tavoitteita, muutos ei koske kyseisiin kausiin. Tästä ei anneta virhettä vaan maksulaji tulee voimaan annetusta alkupäivästä lähtien niille kausille joilla ei ole muutoksenestettyjä tavoitteita.
POST sopimukset/{sopimus_id}/maksulajit/{maksulaji_id}/voimassaolo/paivita Muuttaa sopimuksen maksulajin voimassaoloaikaa, eli alku- ja loppupäivää. Loppupäivän voi päivittää tyhjäksi, jolloin maksulaji on toistaiseksi voimassa. Alkupäivä on pakollinen. Jos maksulajia ei ole kytketty sopimukselle, nousee virhe. Sopimuksen tavoitteet tulee tarvittaessa virkistää erillisellä kutsulla
POST sopimukset/{sopimus_id}/maksulajit/{maksulaji_id}/paata Päättää sopimuksen maksulajin. Jos maksulajia ei ole kytketty sopimukselle, nousee virhe. Sopimuksen tavoitteet tulee tarvittaessa virkistää erillisellä kutsulla
GET sopimukset/{sopimusId}/velkaerittely/hae?tilannepvm={tilannepvm} Palauttaa pyydetyn sopimuksen velkaerittelyn pyydettynä tilannepäivänä
POST sopimukset/{sopimusId}/peruuta Peruuttaa sopimuksen: Asettaa sopimuksen loppupäivän alkupäivästä edelliseen päivään, sopimuksen tilaksi "Peruttu" sekä kirjaa sopimuksen lokiin "Sopimus peruttu". Lisätään annettu Lokimerkinta "Sopimus peruttu" merkinnän perään. Sopimuksen tavoitteet tulee tarvittaessa virkistää erillisellä kutsulla
POST sopimukset/{sopimusId}/tavoitteet/hae Palauttaa sopimuksen tavoitteet pyydetyiltä kausilta. Yhdessä haussa palautetaan maksimissaan kolmen vuoden tavoitteet.
GET sopimukset/{sopimusId}/jalkiperinta/saldo Palauttaa pyydetyn sopimuksen jälkiperinnän saldon kuluvana päivänä
POST sopimukset/{sopimus_id}/liitteet/{liite_id}/uusiversio Lisää annetun tiedoston sopimuksen liitteeksi.

Tarjous

Toiminnot tarjousten käsittelyihin ja hakuihin

APIDescription
GET tarjoukset/{tarjous_id} Hakee tarjouksen tiedot id:llä
GET tarjoukset?osapuoli_id={osapuoli_id} Hakee listan tarjousten yhteenvedoista osapuoli id:llä
GET tarjoukset?hakemus_id={hakemus_id} Hakee listan tarjousten yhtenvedoista hakemus id:llä
GET tarjoukset/lomakevalinnat Palauttaa tarjousvastaus-lomakkeen joka sisältää tarjouksen vastauksen valintatiedot
POST tarjoukset/{tarjous_id}/hyvaksy Hyväksyy asuntotarjouksen. Tarjouksesta myös tehdään esisopimus mikäli tarjouksella ei ole jo sopimusta ja Tampuurin asetukset sen sallii. Kohteen status päivitetään johonkin Tampuurin asetuksien mukaan.
POST tarjoukset/{tarjous_id}/hylkaa Hylkää asuntotarjouksen
POST tarjoukset/lisaa Lisää tarjouksen hakemukselle.
PATCH tarjoukset/{tarjousId}/paivita Päivittää tarjousta annettujen parametrien mukaan.
POST tarjoukset/{tarjous_id}/ensurekohdestatus Varmistaa, että tarjouksen kohteen status on oikeassa tilassa. Sopimuksella -tilassa tyhjennetään myös kohteen vapautumispäivä.


Tarkastus

Tarkastuksen yleiset toiminnot

APIDescription
POST tarkastukset/omat Palauttaa kokoelman käyttäjän tarkastuksia
POST tarkastukset/selaa Selaa tarkastuksia halutuin hakuehdoin
GET tarkastukset/{id}/perustiedot Palauttaa tarkastuksen perustiedot
PATCH tarkastukset/{id}/update Päivittää tarkastuksen tiedot patchina
POST tarkastukset Luo uuden tarkastuksen.
POST tarkastukset/update/tarkastusajat Päivittää tarkastusajan
POST tarkastukset/update/tarkastajat Päivittää tarkastajan tarkastuksille

TarkastusKohde

Tarkastuksien pintoihin ja varusteisiin liittyvien tarkastuskohteiden palvelut.

APIDescription
GET tarkastukset/{id}/huoneet Palauttaa huoneet ja tarkastuskohteet
POST tarkastukset/{id}/huoneet/{huoneid}/tarkastuskohteet/{tarkastuskohdeid} Tallentaa tarkastuksen yksittäisen pinnan tai varusteen tarkastuksen tuloksen
POST tarkastukset/ilmoitus/{ilmoitusid}/tarkastuskohteet/tallennukset Tallentaa annetun ilmoitusidn huoneiden tarkastuskohteiden ilmoitukseksi

TarkastusKulutus

Tarkastuksen kulutuslukemiin lliittyvät toiminnot

APIDescription
POST tarkastukset/muutto/{muuttoid}/kulutuslukemat/tallenna Tallentaa tarkastuksen yhteydessä tehtävän mittrienluvun tiedot.
GET tarkastukset/muutto/{muuttoid}/kulutuslukemat Haetaan mittarit
GET tarkastukset/mittarit Haetaan mittarit

TarkastusLiitteet

Tarkastuksien liitepalvelut

APIDescription
GET tarkastukset/{id}/liitteet Hakee tarkastuksen liitteet.
GET tarkastukset/liitteet/{liiteid}/kuva?MaxWidth={MaxWidth}&MaxHeight={MaxHeight} Hakee tarkastukselle liitetyn kuvan tietyn kokoisena.
GET tarkastukset/liitteet/{liiteid}/viimeisin Hakee tarkastuksen liiteen uusimman tiedoston.
POST tarkastukset/{id}/liitteet/lisaa Lisää liitteen tarkastukselle.
POST tarkastukset/{id}/tarkastuskohde/{tarkastuskohdeid}/liitteet/lisaa Lisää liitteen tarkastuksen pinnalle tai varusteelle.
GET tarkastukset/{id}/tarkastuskohde/{tarkastuskohdeid}/liitteet Hakee tarkastuksen pinnan tai varusteen liitteet.
DELETE tarkastukset/liitteet/{liiteid}/poista Poistaa tarkastuksen tai tarkastuskohteen liitteen.
POST tarkastukset/liitteet/{id}/versio/lisaa?liiteid={liiteid} Lisää uuden tiedostoversion liitteelle.
GET tarkastukset/{id}/liitteet/all Hakee tarkastuksen ja tarkastuskohteiden liitteet.

TarkastusLisatiedot

Tarkastuksien kohdetyyppi neutraalin palvelin Lisätietojen controlleri Lisätietojen palvelut sekä toissijaisien tietojen palvelut

APIDescription
GET tarkastukset/{id}/lisatiedot Palauttaa tarkastuksen lisätiedot
GET tarkastukset/{id}/asukkaat Palauttaa halutun tarkastuksen asukkaat
GET tarkastukset/{id}/pidatystiedot Palauttaa tarkastuksen pidätystiedot
POST tarkastukset/{id}/pidatystiedot/update Tallentaa pidätystiedot tarkastuksen muutolle.
POST tarkastukset/kohteet/viimeisin/perustiedot Hakee kohteiden viimeisimmän valmiin tarkastuksen tiedot.
GET tarkastukset/{id}/avaimet !!!DUMMY!!! Palauttaa tarkastuksen avaimet

TarkastusLoki

Tarkastuksien lokipalvelut

APIDescription
GET tarkastukset/{id}/loki?Offset={Offset}&Limit={Limit} Palauttaa tarkastuksen lokin sivutettuna.
POST tarkastukset/loki/lisaa Lisää merkinnän viestilokiin

TarkastusMallit

Tarkastuksen malleihin liittyvät palvelut

APIDescription
GET tarkastukset/mallit/{typeid}/huoneet Haetaan kaikkien mallihuoneiden tiedot
POST tarkastukset/mallit/{kohdeid}/huoneet/tallenna Päivittää huonevalinnat kohteelle

TarkastusOffline

Tarkastuksien pintoihin ja varusteisiin liittyvien tarkastuskohteiden palvelut.

APIDescription
POST offline/tarkastukset/{tarkastusid}/tarkastuskohteet/tallenna Tallentaa tarkastuksen tarkastuskohteet offline toimintoa varten ja palauttaa huoneet tarkastuskohteineen.

TarkastusValinnat

Sisältää palveluita asetuksien ja tarkastuksiin liittyvien staattisten tietojen hakemiseen.

APIDescription
GET tarkastukset/asetukset Palauttaa tarkastus X käyttämät asetukset
GET tarkastukset/valinnat Tarkastus valintalistat.

Tehtava

Tarjoaa tehtävärekisterin palveluita.

APIDescription
GET tehtava/{tyyppi}/{id} Palauttaa pyydetyn tehtävän. Tehtävällä ei ole tyyppien yli ulottuvaa yksilöllistä id:tä, joten tehtävää pitää hakea yhdessä tyypin kanssa.
POST tehtava/selaa Palauttaa osakokoelman hakuehdot täyttäviä tehtäviä. Vähintään jokin seuraavista tiedoista on toimitettava: KohdeId, TyonsuorittajaId tai IlmoittajaId. Toimittaaksesi useita kohteita määrittele parametri monta kertaa. Palautettavien tehtävien järjestys on seuraava. 1. Myöhässä olevat tehtävät (mitä enemmän myöhässä sitä korkeammalla tulosjoukossa). 2. Tehtävän deadline täyttymässä. 3. Tehtävän suoritusaika. 4. Tehtävien kirjausjärjestys.
POST tehtava/arkisto/selaa Palauttaa osakokoelman hakuehdot täyttäviä arkistoituja tehtäviä. Vähintään jokin seuraavista tiedoista on toimitettava: KohdeId, TyonsuorittajaId tai IlmoittajaId. Toimittaaksesi useita kohteita määrittele parametri monta kertaa.
POST tehtava/{tehtavatyyppi}/{id}/vaihdatyonsuorittaja Asettaa tehtävälle uuden työnsuorittajan.

Test

APIDescription
GET testit/{testi_id} Testimetodi WebApin savutestaamiselle

Tiedosto

APIDescription
GET tiedostot?tiedosto_id={tiedosto_id} No documentation available.
GET tiedostot/content?tiedosto_id={tiedosto_id} No documentation available.
GET tiedostot/{tiedosto_id}/content No documentation available.


Tunnus

APIDescription
GET tunnukset/tarkistakirjautuminen Palauttaa kutsun kirjautumistiedot.

Tuoterekisteri

APIDescription
GET tuotteet/liitteet/{liite_id} Palauttaa tuotteen liiteen sisällön.
GET tuoterekisteri/tuotteet/liitteet/{liite_id} Palauttaa tuotteen liiteen sisällön.
GET tuoterekisteri/{kohdeid}/toimialat Hakee kaikki kohteen toimialat
GET tuoterekisteri/{kohdeid}/toimialat/{toimialaid}/toimittajat Hakee kaikki toimialan toimittajat
POST tuoterekisteri/{kohdeid}/toimialat/{toimialaid}/toimittajat/hae Hakee toimialan toimittajia hakutermillä
GET tuoterekisteri/toimittaja/{toimittajaid}/tuotteet Hakee toimittajan tuotekatalogin
GET tuoterekisteri/kirjaukset/tuotteet Hakee kirjautuneen käyttäjän yrityksen kategoroiden kaikki tuotteet.

Työnsuorittajat

APIDescription
GET osapuolet/tyonsuorittajat?kohde_id={kohde_id} Hakee kohteen tyonsuorittajat, eli yritykset ja ne henkilöt, joilla on käyttäjätunnukset.
GET osapuolet/tyonsuorittajat?hakusana={hakusana} Hakee tyonsuorittajat, eli yritykset ja ne henkilöt, joilla on käyttäjätunnukset hakusanan perusteella.
GET osapuolet/tyonsuorittajat/valintalista/{hakusana} Hakee tyonsuorittajat, eli yritykset ja ne henkilöt, joilla on käyttäjätunnukset hakusanan perusteella.

Viestinta

APIDescription
GET internetviestit/{id}/otsikot Palauttaa Internetviestin yksilöllisellä id:llä.
GET internetviestit/osapuoli/{osapuoli_id}/otsikot Hakee osapuolen internetviestit
GET internetviestit/kohde/{kohde_id}/otsikot Hakee kohteelle määritetyt internetviestien otsikot
GET internetviestit/{id} Hakee internetviestin id:llä
POST internetviestit/create Lisää uuden internetviestin.
GET internetviestit/liitteet/{id} Palauttaa liitteen sisällön.
GET internetviestit/otsikot?osapuoli_id={osapuoli_id} VANHENTUNUT, käytä GET internetviestit/osapuoli/{osapuoli_id}/otsikot Hakee osapuolen internetviestit
GET internetviestit/otsikot?kohde_id={kohde_id} VANHENTUNUT, käytä GET internetviestit/kohde/{kohde_id}/otsikot Hakee kohteelle määritetyt internetviestien otsikot
POST internetviestit VANHENTUNUT, käytä GET internetviestit/create Lisää uuden internetviestin.

YhteydetApi

Yhteyksiä hallinnoiva kontrolleri.

APIDescription
GET yhteydet/osapuoli/{id} OBSOLETE!!! Toimii virheellisesti, käytä reittiä "osapuoli/{id}/kohdetiedoilla"
POST yhteydet/kohde/{id}/hae Palauttaa osapuolen voimassa olevat yhteydet.
GET yhteydet/osapuoli/{id}/kohdetiedoilla Palauttaa osapuolen voimassa olevat yhteydet kohteen hierarkian kohdetidoilla.
POST yhteydet/lisaa Lisää uuden yhteyden kohteen ja osapuolen välille.
POST yhteydet/{yhteysid}/paivita Päivittää yhteyden tietoja jos yhteys, kohde ja osapuoli ovat käytettävissä.
GET yhteydet/{yhteysid} Hakee yhteyden tiedot Id:llä.
DELETE yhteydet/{yhteysid}/poista Tekee kovan poiston yhteydelle.
POST yhteydet/asukkaat/hae Hakee asukasyhteyksiä valinnaisella kohdeIdllä ja hakutermillä. Jos kohdeIdtä ei anneta, haetaan kaikista omien kustannuspaikkojen asukkaista. Hakusanalla voi hakea asukkaita nimen, sähköpostin, matkapuhelinnumeron tai puhelinnumeron mukaan.