Kutsun headerit
Jokaisessa Tampuuri API:in kohdistuvassa kutsussa tulee olla seuraavat header-tiedot:
X-TampuuriAvain: XXXXXXXX-XXXX-XXXX X-AsiakasNimi: Agenteq Solutions Oy X-Ohjelmistoversio: AsiakasOhjelmistoX_v1.4.2 X-TiliNimi: graniitti.tampuuri.fi X-Kayttajatunnus: mikko1 X-Salasana: ******** X-Lat: 60.2298830 X-Long: 25.0087430 Content-Type: application/json1 2 3 4 5 6 7 8 9
- Tampuuri-Avain, jolla kirjaudutaan järjestelmään ja kirjataan transaktiolokimerkinnät (laskutuksen pohja). Huom! Oikea TampuuriAvain ja Asiakasnimi löytyy toistaiseksi vain pilvipalvelun tietokannasta.
- Tampuuri-Avaimen kanssa käsikädessä kulkeva asiakasnimi. Tämän ja TampuuriAvaimen perusteella kutsu joko hyväksytään tai hylätään Cloudissa.
- Tunnistettava ohjelmistoversio, esim. Latomo_v2.8 tai WP_v1.5
- Tampuuri-Tilin nimi (Keskuskanta.Tilit-taulussa oleva). Tilinimi on globaalisti uniikki. Tilit, joilla rest-operaatiot toimii nähtävissä.
- Tampuuri-käyttäjän käyttäjätunnus
- Tampuuri-käyttäjän salasana
- Kutsun lähetyspaikan Latitude-koordinaatti. Käytetään yleensä mobiililaitteissa. Ei pakollinen.
- Kutsun lähetyspaikan Longitude-koordinaatti. Käytetään yleensä mobiililaitteissa. Ei pakollinen.
- Kutsun content-type. Yleensä application/json
AspaAineistotApi
API | Description |
---|---|
POST asiakaspalvelu/aineistot/pankkiyhteys/saapumisilmoitus/lisaa |
!!!Vain sisäiseen käyttöön!!! Lisää pankkiyhteysaineiston saapumisilmoituksen järjestelmään |
AspaHakemusApi
API | Description |
---|---|
GET asiakaspalvelu/hakemukset/{hakemusId}/hakemuspvmts |
!!!Vain sisäiseen käyttöön!!! Palauttaa annetun hakemuksen luonnin aikaleiman. |
POST asiakaspalvelu/hakemukset/{hakemusId}/hakemuspvmts/aseta |
!!!Vain sisäiseen käyttöön!!! Päivittää annetulle hakemukselle luonnin aikaleiman. |
AspasopimusApi
API | Description |
---|---|
GET asiakaspalvelu/sopimukset/{sopimusId} |
!!!Vain sisäiseen käyttöön!!! Hakee sopimuksen tiedot id:llä |
GET asiakaspalvelu/sopimukset/{sopimusId}/yhteenveto |
!!!Vain sisäiseen käyttöön!!! Hakee sopimuksen yhteenvedon id:llä |
GET asiakaspalvelu/sopimukset/tarjous/{tarjousId} |
!!!Vain sisäiseen käyttöön!!! Hakee listan sopimusten yhteenvedoista tarjous id:llä |
GET asiakaspalvelu/sopimukset/henkilotunnus/{henkilotunnus} |
!!!Vain sisäiseen käyttöön!!! Hakee listan sopimusten yhteenvedoista henkilötunnuksella |
GET asiakaspalvelu/sopimukset/osapuoli/{osapuoliId} |
!!!Vain sisäiseen käyttöön!!! Hakee listan sopimusten yhteenvedoista osapuoli id:llä |
GET asiakaspalvelu/sopimukset/osapuoli/{osapuoliId}/irtisanottavat |
!!!Vain sisäiseen käyttöön!!! Palauttaa listan sopimusten yhteenvedoista osapuolen irtisanottavissa olevista sopimuksista. |
POST asiakaspalvelu/sopimukset/{sopimusId}/palvelu/lisaa |
!!!Vain sisäiseen käyttöön!!! Lisää palvelun (esim. saunavuoron tai autopaikan) sopimukselle. Palvelun hinnan tulee löytyä kohteen maksulajeista. |
POST asiakaspalvelu/sopimukset/{sopimusId}/palvelu/paata |
!!!Vain sisäiseen käyttöön!!! Päättää palvelun (esim. saunavuoron tai autopaikan) sopimukselta. |
GET asiakaspalvelu/sopimukset/{sopimusId}/asuntotarkastukset |
!!!Vain sisäiseen käyttöön!!! Hae sopimukseen liittyvät asuntotarkastukset. |
POST asiakaspalvelu/sopimukset/{sopimusId}/liitteet/selaa |
!!!Vain sisäiseen käyttöön!!! Hakee sopimuksen liitteet |
GET asiakaspalvelu/sopimukset/{sopimusId}/liitteet/{liiteId}/tiedostot/viimeisin |
!!!Vain sisäiseen käyttöön!!! Palauttaa sopimuksen liitetiedoston pyydettäessä liitteen id:llä. |
GET asiakaspalvelu/sopimukset/{sopimusId}/tiedostot/{tiedostoId} |
!!!Vain sisäiseen käyttöön!!! Palauttaa sopimuksen liitetiedoston pyydettäessä tiedoston id:llä. |
POST asiakaspalvelu/sopimukset/{sopimusId}/liitteet/lisaa |
!!!Vain sisäiseen käyttöön!!! Lisää annetun tiedoston sopimuksen liitteeksi. |
POST asiakaspalvelu/sopimukset/liitteet/yleiset/selaa |
!!!Vain sisäiseen käyttöön!!! Hakee sopimuskategorian yleiset liitteet |
GET asiakaspalvelu/sopimukset/kustannuspaikka/{kustannuspaikkaId}/liitteet/yleiset/tiedostot/{tiedostoId} |
!!!Vain sisäiseen käyttöön!!! Palauttaa sopimuksen yleisen liitetiedoston pyydettäessä tiedoston id:llä. |
GET asiakaspalvelu/sopimukset/{sopimusId}/saldo |
!!!Vain sisäiseen käyttöön!!! Palauttaa sopimuksen saldon |
GET asiakaspalvelu/sopimukset/irtisanomisilmoitukset/alkupvm/{alkupvm} |
!!!Vain sisäiseen käyttöön!!! Hakee irtisanomisilmoituksia tietystä ajankohdasta lähtien. |
POST asiakaspalvelu/sopimukset/{sopimusId}/osapuolet/lisaa |
!!!Vain sisäiseen käyttöön!!! 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 asiakaspalvelu/sopimukset/{sopimusId}/osapuolet/{osapuoliId}/paivita |
!!!Vain sisäiseen käyttöön!!! 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 asiakaspalvelu/sopimukset/{sopimusId}/osapuolet/paata |
!!!Vain sisäiseen käyttöön!!! 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. Osapuolelle tallennetaan irtisanoutunutPvm:ksi kuluva ajanhetki. Jos osapuoli ei löydy sopimukselta, niin toimintoa ei suoriteta ja palautetaan virhe 400 bad request. |
POST asiakaspalvelu/sopimukset/{sopimusId}/osapuolet/{osapuoliId}/yhteys/paata |
!!!Vain sisäiseen käyttöön!!! Päättää asiakaspalvelu sopimuksen osapuolen osapuoliyhteyden kohderekisteristä, jos tuo yhteys on sopimusosapuolelle määritelty. Yleensä kyseessä on Asukas- tai autopaikan haltija-yhteys, mutta tämä riippuuu Tampuurin asetuksista. |
POST asiakaspalvelu/sopimukset/{sopimusId}/osapuolet/poista |
!!!Vain sisäiseen käyttöön!!! 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 asiakaspalvelu/sopimukset/{sopimusId}/vakuusmaksut |
!!!Vain sisäiseen käyttöön!!! Hakee listan sopimuksen vakuusmaksutiedoista |
POST asiakaspalvelu/sopimukset/{sopimusId}/vakuusmaksut/palautustilinumero/muuta |
!!!Vain sisäiseen käyttöön!!! Päivittää sopimukselle vakuudenpalautustilinumeron ja päivittää palautustilinumeron myös vakuusmaksu suoritukselle mikäli vakuus on maksettu yhdessä erässä. |
POST asiakaspalvelu/sopimukset/{sopimusId}/hyvaksy |
!!!Vain sisäiseen käyttöön!!! Allekirjoittaa sopimuksen kyseisen osapuolen osalta |
POST asiakaspalvelu/sopimukset/{sopimusId}/hylkaa |
!!!Vain sisäiseen käyttöön!!! Muuttaa hankintaehdotuksen tilan hylätyksi. |
GET asiakaspalvelu/sopimukset/{sopimusId}/sopimusdokumentti |
!!!Vain sisäiseen käyttöön!!! Hakee sopimuksen uusimman sopimusdokumentin. |
GET asiakaspalvelu/sopimukset/{sopimusId}/vakuuslasku |
!!!Vain sisäiseen käyttöön!!! Palauttaa sopimuksen vakuuslaskun tietoja |
POST asiakaspalvelu/sopimukset/{sopimusId}/laskevuokra |
!!!Vain sisäiseen käyttöön!!! Laskee sopimuksen tilannepäivän mukaisen laskutuskauden vuokran |
POST asiakaspalvelu/sopimukset/{sopimusId}/allekirjoitus/valmis |
!!!Vain sisäiseen käyttöön!!! Muuttaa sopimuksen allekirjoituksen tilaksi Valmis ja asettaa sopimuksen allekirjoituksen päivämääräksi kuluvan päivän |
POST asiakaspalvelu/sopimukset/{sopimusId}/allekirjoitus/peruuta |
!!!Vain sisäiseen käyttöön!!! 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 asiakaspalvelu/sopimukset/{sopimusId}/allekirjoitus/kesken |
!!!Vain sisäiseen käyttöön!!! Muuttaa sopimuksen allekirjoituksen tilaksi Kesken. Sopimuksen allekirjoituksen tilan tulee olla Aloitettu jotta allekirjoituksen voi asettaan tilaan kesken. |
GET asiakaspalvelu/sopimukset/allekirjoitettavat |
!!!Vain sisäiseen käyttöön!!! Hakee listan sähköisesti allekirjoitettavissa olevien sopimusten id:stä Sopimukset joiden allekirjoituksen tila on Aloitettu ja joilla ei ole vielä allekirjoituspäivää |
GET asiakaspalvelu/sopimukset/{sopimusId}/irtisanomislomakevalinnat |
!!!Vain sisäiseen käyttöön!!! Hakee asukkaan sähköisen irtisanomisen lomakkeen valinnat |
GET asiakaspalvelu/sopimukset/{sopimusId}/perustiedot |
!!!Vain sisäiseen käyttöön!!! Etsii sopimuksen perustiedot, palauttaa nullin jos sopimusta ei löydy |
POST asiakaspalvelu/sopimukset/{sopimusId}/vakuuslasku/kuittaamaksetuksi |
!!!Vain sisäiseen käyttöön!!! Merkitsee sopimuksen vakuuslaskun maksetuksi |
POST asiakaspalvelu/sopimukset/{sopimusId}/irtisano |
!!!Vain sisäiseen käyttöön!!! Tallentaa sopimuksen irtisanomisen tiedot järjestelmään jatkokäsittelyä varten |
POST asiakaspalvelu/sopimukset/lisaa |
!!!Vain sisäiseen käyttöön!!! Luo järjestelmään uuden sopimuksen |
POST asiakaspalvelu/sopimukset/{sopimusId}/vakuuslasku/lisaa |
!!!Vain sisäiseen käyttöön!!! Lisää vakuuslaskun sopimukselle |
POST asiakaspalvelu/sopimukset/esisopimukset/lisaa |
!!!Vain sisäiseen käyttöön!!! Luo järjestelmään uuden esisopimuksen |
POST asiakaspalvelu/sopimukset/{sopimusId}/suoritukset |
!!!Vain sisäiseen käyttöön!!! Palauttaa sopimuksen suoritukset (normaali ja palautus tyyppiset) annetulla aikavälillä |
GET asiakaspalvelu/sopimukset/sopimukset/{sopimus_id}/maksulajit/hae |
!!!Vain sisäiseen käyttöön!!! Hakee sopimuksen maksulajit ja tariffit |
POST asiakaspalvelu/sopimukset/{sopimusId}/maksulajit/lisaa |
!!!Vain sisäiseen käyttöön!!! 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 asiakaspalvelu/sopimukset/{sopimusId}/maksulajit/jyvittamaton/lisaa |
HUOM! suositellaan että käytetään POST asiakaspalvelu/sopimukset/{sopimusId}/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 asiakaspalvelu/sopimukset/lomakevalinnat |
!!!Vain sisäiseen käyttöön!!! Palauttaa sopimuslomakkeen valintoja |
POST asiakaspalvelu/sopimukset/{sopimusId}/virkistatavoitteet |
!!!Vain sisäiseen käyttöön!!! Luo/päivittää sopimukselle sen maksulajeista tavoitteet ja luo ns. laskupohjat sopimukselle. |
PATCH asiakaspalvelu/sopimukset/{sopimusId}/paivita |
!!!Vain sisäiseen käyttöön!!! 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 asiakaspalvelu/sopimukset/{sopimusId}/paata |
!!!Vain sisäiseen käyttöön!!! Päättää sopimuksen annettujen parametrien mukaan. Jos Yhteystiedot parametria ei ole annettu jätetään uudet yhteystiedot sopimuksella entiselleen. Muussa tapauksessa tallennetaan yhteystiedot annettuina. |
GET asiakaspalvelu/sopimukset/{sopimusId}/alisopimukset/voimassaolevat/hae |
!!!Vain sisäiseen käyttöön!!! Palauttaa annettuun sopimukseen liittyvät voimassaolevat alisopimukset. |
POST asiakaspalvelu/sopimukset/{sopimusId}/irtisanominen/muutto/luo |
!!!Vain sisäiseen käyttöön!!! Lisää ulosmuuton sopimukselle. |
POST asiakaspalvelu/sopimukset/{sopimusId}/irtisanominen/lahetavahvistus |
!!!Vain sisäiseen käyttöön!!! Lähettää sopimuksen irtisanomisen vahvistusviestin pyydetylle osapuolelle. |
POST asiakaspalvelu/sopimukset/{sopimusId}/osapuoli/{osapuoliId}/irtisanominen/vahvista |
!!!Vain sisäiseen käyttöön!!! Vahvistaa sopimuksen osapuolen irtisanomisen järjestelmään. |
GET asiakaspalvelu/sopimukset/irtisanominen/asetukset |
!!!Vain sisäiseen käyttöön!!! Palauttaa sopimuksen sähköisen irtisanomisprosessin asetuksia |
POST asiakaspalvelu/sopimukset/{sopimusId}/osoitepaivitys/lisaa |
!!!Vain sisäiseen käyttöön!!! Lisää osoitepäivitysjonoon tiedot, mikäli se on mahdollista. |
GET asiakaspalvelu/sopimukset/{sopimusId}/laskut/kausilasku/hae?Vuosi={Vuosi}&Kuukausi={Kuukausi}&Kieli={Kieli} |
!!!Vain sisäiseen käyttöön!!! Palauttaa pyydetyn kauden kausilaskun finvoice-muodossa |
GET asiakaspalvelu/sopimukset/{sopimusId}/velkaerittely/hae?tilannepvm={tilannepvm} |
!!!Vain sisäiseen käyttöön!!! Palauttaa pyydetyn sopimuksen velkaerittelyn pyydettynä tilannepäivänä |
POST asiakaspalvelu/sopimukset/{sopimusId}/osapuolet/{osapuoliId}/irtisanomistiedot/tyhjenna |
!!!Vain sisäiseen käyttöön!!! Tyhjentää sopimus osapuolen irtisanomistiedot. |
POST asiakaspalvelu/sopimukset/{sopimusId}/asukkaat/kohdeyhteydet/luo |
!!!Vain sisäiseen käyttöön!!! Lisää sopimuksen asukkaille kohdeyhteydet ja päivittää ne sopimuksen osapuoli tauluun jos niitä ei vielä ole. |
POST asiakaspalvelu/sopimukset/{sopimus_id}/maksulajit/{maksulaji_id}/uudelleen/kytke |
!!!Vain sisäiseen käyttöön!!! 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 asiakaspalvelu/sopimukset/{sopimusId}/irtisanominen/sopimuspaatetty/viesti/laheta |
!!!Vain sisäiseen käyttöön!!! Lähettää sopimuksen irtisanomisen sopimuksen päättämisen viesti pyydetylle osapuolelle. |
POST asiakaspalvelu/sopimukset/{sopimus_id}/maksulajit/{maksulaji_id}/voimassaolo/paivita |
!!!Vain sisäiseen käyttöön!!! 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 asiakaspalvelu/sopimukset/{sopimus_id}/maksulajit/{maksulaji_id}/paata |
!!!Vain sisäiseen käyttöön!!! Päättää sopimuksen maksulajin. Jos maksulajia ei ole kytketty sopimukselle, nousee virhe. Sopimuksen tavoitteet tulee tarvittaessa virkistää erillisellä kutsulla |
AspaTehtavaApi
API | Description |
---|---|
POST asiakaspalvelu/tehtavat/{tehtava_id}/kasittelytapahtuma/lisaa |
!!!Vain sisäiseen käyttöön!!! Lisää tehtävälle käsittelytapahtuman. |
POST asiakaspalvelu/tehtavat/{tehtava_id}/kuittaatehdyksi |
!!!Vain sisäiseen käyttöön!!! Kuittaa asiakaspavelun tehtäväjonosta tehtävän tehdyksi tehtävän id:n perusteella. |
POST asiakaspalvelu/tehtavat/lisaa |
!!!Vain sisäiseen käyttöön!!! Lisää uuden tehtävän aspan työjonoon |
GET asiakaspalvelu/tehtavat/{id} |
!!!Vain sisäiseen käyttöön!!! Palauttaa työjonon tehtävän |
Asumisoikeus
API | Description |
---|---|
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
API | Description |
---|---|
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
API | Description |
---|---|
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 |
Avainhallinta
API | Description |
---|---|
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 |
AvainhallintaNoutoautomaatti
API | Description |
---|---|
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 |
Diagnostics
API | Description |
---|---|
GET diagnostics/selftest/{securitytoken} |
No documentation available. |
GET diagnostics/information |
No documentation available. |
GET diagnostics/simpleselftest/{securitytoken} |
No documentation available. |
Dokumenttipankki
Dokumenttipankin toiminnot
EtupisteetOsapuoliTapahtuma
API | Description |
---|---|
GET etupisteet/osapuolet/{osapuoliId}/tapahtumat |
Hakee osapuolen tapahtumat |
EtupisteetTapahtumaTyyppi
API | Description |
---|---|
GET etupisteet/tapahtumatyypit |
Hakee tapahtumatyypit |
Hakemus
Toiminnot hakemusten käsittelyyn ja hakuihin
API | Description |
---|---|
GET hakemukset/{hakemusId} |
Palauttaa hakemuksen tiedot |
GET hakemukset?osapuoli_id={osapuoli_id} |
Palauttaa yhteenvedot osapuolen voimassa olevista hakemuksista. |
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. |
Hankintaehdotus
Hankintaehdotusten luontiin tarkoitetut toiminnot
API | Description |
---|---|
POST hankintaehdotukset |
Hankintaehdotuksen lisäämisen metodi. |
POST hankintaehdotukset/selaa |
Hakee hankintaehdotuksen perustiedot |
GET hankintaehdotukset?Tila={Tila}&KohdeId={KohdeId} |
Hakee kaikki parametreja vastaavat hankintaehdotukset |
POST hankintaehdotukset/{hankintaehdotus_id}/hyvaksy |
Muuttaa hankintaehdotuksen tilan hyväksytyksi. |
POST hankintaehdotukset/{hankintaehdotus_id}/hylkaa |
Muuttaa hankintaehdotuksen tilan hylätyksi. |
POST hankintaehdotukset/{hankintaehdotus_id}/lahetetty |
Muuttaa hankintaehdotuksen tilan lähetetyksi. |
GET hankintaehdotukset/{kohdeid}/toimialat |
Hakee kaikki kohteen toimialat |
GET hankintaehdotukset/{kohdeid}/toimialat/{toimialaid}/toimittajat |
Hakee kaikki toimialan toimittajat |
POST hankintaehdotukset/{kohdeid}/toimialat/{toimialaid}/toimittajat/hae |
Hakee toimialan toimittajia hakutermillä |
GET hankintaehdotukset/{id} |
Haetaan hankintaehdotuksen tiedot Id:llä. |
POST hankintaehdotukset/{id}/valmis |
Muutetaan hankintaehdotus tilaan Valmis |
POST hankintaehdotukset/toimijan/selaa |
Hakee kaikki yrityksen hankintaehdotukset sivutetusti. |
POST hankintaehdotukset/{id}/toimitetuksi |
Muuttaa hankintaehdotuksen tilan toimitetuksi. |
POST hankintaehdotukset/{id}/lahetetaan |
Lähettää hankintaehdotuksen hyväksyttäväksi ja tallentaa lähettämiseen liittyvän kommentin. |
POST hankintaehdotukset/{id}/hyvaksyttavaksi |
Lähettää hankintaehdotuksen hyväksyttäväksi. |
HenkiloApi
Henkilötietoihin erikoistunut kontrolleri. Osapuolien toimintoja käsitellään yrityksiin erikoistuneessa HenkiloApiController-luokassa. Yritysten toimintoja käsitellään yrityksiin erikoistuneessa YritysApiController-luokassa.
API | Description |
---|---|
GET osapuolitiedot/henkilot/{id} |
!!!Vain sisäiseen käyttöön!!! Hakee henkilön id:llä. |
POST osapuolitiedot/henkilot/hakusana?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen} |
!!!Vain sisäiseen käyttöön!!! Palauttaa kokoelman henkilöitä, joiden määrätty parametri vastaa annettuun hakusanaan. Henkilöillä on "Parametrit"-kokoelma, mutta kokoelma on aina tyhjä. |
POST osapuolitiedot/henkilot/selaa |
!!!Vain sisäiseen käyttöön!!! Selaa henkilöitä, vastaus sivutetusti. |
POST osapuolitiedot/henkilot/create |
!!!Vain sisäiseen käyttöön!!! Lisää henkilön. |
Huoltokalenteri
Huoltokirjan palvelut
API | Description |
---|---|
GET huoltokirja/huoltokalenteri?KohdeId={KohdeId}&Vuosi={Vuosi} |
Hakee huoltokalenterin annettujen kyselytietojen perusteella. |
Huoltotehtava
Tarjoaa huoltotehtävien palveluita.
API | Description |
---|---|
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
API | Description |
---|---|
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. |
Ilmoitus
Ilmoitusten hakuun ja luontiin tarkoitetut toiminnot
API | Description |
---|---|
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}/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.
API | Description |
---|---|
GET ilmoitukset/{ilmoitusId}/kommentit |
Palauttaa kokoelman ilmoitukselle liitetyistä kommenteista. |
POST ilmoitukset/{ilmoitus_id}/kommentit/lisaa |
Lisää uuden kommentin ilmoitukselle |
IlmoitusLoki
API | Description |
---|---|
GET ilmoitukset/{ilmoitus_id}/loki?Offset={Offset}&Limit={Limit} |
Palauttaa ilmoituksen lokitietoja sivutestusti |
IlmoitusValinnat
Ilmoitusten valinnat
API | Description |
---|---|
GET ilmoitukset/kohteen/{kohde_id}/tyonsuorittajat |
Palauttaa ilmoituksen työnsuorittajien valinta listat. |
Integraatiot
API | Description |
---|---|
GET integraatiot/haltu/kirjautumislinkki?osapuolet_id={osapuolet_id} |
Palauttaa Haltun kirjautumislinkin. |
GET integraatiot/asiakaspalvelu/sopimukset/{sopimus_id}/osapuoli/{osapuolet_id}/sisaanmuuttotarkastus/kirjautumislinkki |
HUOM! Käytetään vain poikkeustapauksessa, ei yleiseen käyttöön!!! Palauttaa cTampuurin suorakirjautumislinkin sisäänmuuttotarkastukselle. Palauttaa null:in jos tarkastusta ei ole. |
KayttopaivakirjaKommentti
API | Description |
---|---|
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
API | Description |
---|---|
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
API | Description |
---|---|
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
API | Description |
---|---|
GET kayttopaivakirja/toimenpideluokat |
Hakee Käyttöpäiväkirjojen toimenpideluokat. |
KihlaKeskustelu
API | Description |
---|---|
POST kihla/keskustelut/search |
Hakee keskusteluja määrätyillä parametreillä. |
KihlaKommentti
API | Description |
---|---|
GET kihla/teknisettarkastukset/{tekninenTarkastusId}/tarkastuskohdat/{tarkastuskohtaId}/kommentit |
Hakee kommentit teknisen tarkastuksen ja tarkastuskohdan id:illä. |
GET kihla/teknisettarkastukset/{tekninenTarkastusId}/kommentit |
Hakee kommentit teknisen tarkastuksen Id:llä |
POST kihla/teknisettarkastukset/{tekninenTarkastusId}/tarkastuskohdat/{tarkastuskohtaId}/kommentit/add |
Lisää kommentin tarkastuskohdalle. |
POST kihla/kommentit/{kommenttiId}/update |
Päivittää kommentin tietoja |
DELETE kihla/kommentit/{kommenttiId}/delete |
Poistaa kommentin |
GET kihla/kommentit/{id} |
Hakee kommentin Id:llä |
KihlaMallipohja
API | Description |
---|---|
GET kihla/teknisettarkastukset/mallipohjat |
Palauttaa kaikki teknisten tarkastusten mallipohjat. |
KihlaOsapuoli
API | Description |
---|---|
GET kihla/osapuolet/tarkastajat/search?Hakusana={Hakusana} |
Palauttaa kihlan tarkastajaosapuolet. |
KihlaPäivittäisseuranta
API | Description |
---|---|
GET kihla/paivittaisseurannat/{id} |
Hakee päivittäisseurannan id:llä |
POST kihla/paivittaisseurannat/search |
Hakee päivittäisseurannat hakuehdoilla. |
KihlaTarkastelukierros
API | Description |
---|---|
GET kihla/tarkastelukierrokset |
Palauttaa kaikki tarkastelukierrokset. |
KihlaTarkastuskohta
API | Description |
---|---|
GET kihla/teknisettarkastukset/{tekninenTarkastusId}/tarkastuskohdat |
Hakee teknisen tarkastuksen tarkastuskohdat. |
GET kihla/teknisettarkastukset/{tekninenTarkastusId}/tarkastuskohdat/{id} |
Hakee yksittäisen tarkastuskohdan |
POST kihla/teknisettarkastukset/{tekninenTarkastusId}/tarkastuskohdat/{id}/update |
Päivittää tarkastuskohdan tietoja. |
PATCH kihla/teknisettarkastukset/{tekninenTarkastusId}/tarkastuskohdat/{id}/update |
Päivittää tarkastuskohdan tietoja |
GET kihla/teknisettarkastukset/{tarkastusId}/tarkastuskohdat/{id}/kuvaus |
Hakee tarkastuskohtaan liittyvän kuvauksen |
KihlaTekninenTarkastus
API | Description |
---|---|
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. |
Kohde
API | Description |
---|---|
GET kohteet/{kohde_id} |
Hakee kohteen id:llä ja palauttaa kaikki sille metanimillä haettavissa olevat tiedot. |
PUT 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). |
KohdeApi
API | Description |
---|---|
GET kohdetiedot/kohteet/{id} |
!!!Vain sisäiseen käyttöön!!! Hakee kohteen id:llä ja palauttaa kaikki sille metanimillä haettavissa olevat tiedot. |
POST kohdetiedot/kohteet/{id}/update |
!!!Vain sisäiseen käyttöön!!! Päivittää kohteen tietoja metatietojen perusteella. |
POST kohdetiedot/kohteet?id={id} |
!!!Vain sisäiseen käyttöön!!! Hakee kohteen ja sen alla olevat alikohteet. Jos AlikohteenMetaTyypit on null tai tyhjä niin oletuksena haetaan Rakennus, Huoneisto,Liikehuoneisto, Huone sekä Vuodepaikka tyypeillä. |
GET kohdetiedot/kohteet/{kohdeId}/maksutiedot |
!!!Vain sisäiseen käyttöön!!! Hae kohteen omistajan maksutiedot |
KohdeAsukastieto
Kohteiden asukastietojen käsittelyn rajapinnat.
API | Description |
---|---|
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. |
KohderekisteriHistoria
Kohderekisterin historiatietojen rajapinta.
API | Description |
---|---|
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.
API | Description |
---|---|
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. |
KulutusseurantaKohdeKuukausikulutus
API | Description |
---|---|
POST kulutusseuranta/kulutukset/kuukausikulutus |
Palauttaa hakuehtojen mukaisia kohteiden kuukausikulutustietoja |
KulutusseurantaKohdePäiväkulutus
API | Description |
---|---|
POST kulutusseuranta/kulutukset/paivakulutus |
Palauttaa hakuehtojen mukaisia kohteiden päiväkulutustietoja |
KulutusseurantaKohdeSeurantalaji
API | Description |
---|---|
POST kulutusseuranta/seurantalajit/kohdeseurantalajit |
Palauttaa hakuehtojen mukaisten kohteiden seurantalajit. |
KulutusseurantaKohdeTuntikulutus
API | Description |
---|---|
POST kulutusseuranta/kulutukset/tuntikulutus |
Palauttaa hakuehtojen mukaisia kohteiden tuntikulutustietoja |
KulutusseurantaKohdeVuosikulutus
API | Description |
---|---|
POST kulutusseuranta/kulutukset/vuosikulutus |
Palauttaa hakuehtojen mukaisia kohteiden vuosikulutustietoja |
KulutusseurantaMittari
API | Description |
---|---|
GET kulutusseuranta/kohteet/{kohdeId}/mittarit |
Palauttaa kohteen käytössä olevat mittarit. |
KulutusseurantaMittariLukema
API | Description |
---|---|
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
API | Description |
---|---|
GET kulutusseuranta/seurantalajit |
Palauttaa kaikki seurantalajit. |
KustannuspaikkaApi
API | Description |
---|---|
POST kohdetiedot/kustannuspaikat/selaa |
!!!Vain sisäiseen käyttöön!!! Hakee kustannuspaikat sivutetusti. |
POST kohdetiedot/kustannuspaikat/all |
Hakee kaikki käytettävissä olevat kustannuspaikat. |
POST kohdetiedot/kustannuspaikat/{kustannuspaikka_id}/tyyppi/{metatyyppi}?Metanimet={Metanimet} |
!!!Vain sisäiseen käyttöön!!! Hae Kustannuspaikan alakohteet tyypillä suodatettuna. |
GET kohdetiedot/kustannuspaikat/omat |
!!!Vain sisäiseen käyttöön!!! Käyttäjän kustannuspaikat(Eli on oikeus kp:aan ja on sillä voimassa olevalla yhteydellä jollakin roolilla). |
Kysymyspatteri
Kysymyspatterin kysymysten hakuun hakuun tarkoitetut toiminnot
API | Description |
---|---|
GET kysymyspatterit?type={type} |
Palauttaa kokoelman kysymyspatterin kysymyksiä, jotka ovat kytketty tiettyyn prosessiin(tyyppiin). |
Laina
Lainarekisteri
API | Description |
---|---|
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
API | Description |
---|---|
GET erillislaskut?sopimus_id={sopimus_id}&alkupvm={alkupvm}&loppupvm={loppupvm} |
Hakee erillislaskut annetulta aikaväliltä sopimus id:llä |
Maksulaji
API | Description |
---|---|
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. |
Muutto
API | Description |
---|---|
GET muutot/lomakevalinnat |
Palauttaa muuton mahdolliset valinnat. |
Osakerekisteri
API | Description |
---|---|
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. |
Osapuoli
API | Description |
---|---|
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. |
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}/asukassivutunnukset |
Palauttaa järjestelmässä olevat käyttäjän tunnukset. Mikäli tunnuksia, tai käyttäjää, ei ole palautetaan 404 Not Found. |
POST osapuolet/{osapuoli_id}/asukassivutunnukset |
Muodostaa uuden käyttäjän järjestelmään käyttäen tilin Asukassivuasetuksia. Mikäli käyttäjä on ennestään olemassa palautetaan 200 OK ja käyttäjän tunnukset. Käyttäjän perustaminen palauttaa 201 Created ja muodostetut tunnukset. Olemassa olevan käyttäjän salasanaa ei muuteta. Mikäli jollakin toisella henkilöllä on jo olemassa tunnus, joka halutaan varata aiheutuu tästä poikkeus, Internal Server Error 500. Salasanan puuttuminen aiheuttaa paluuarvon 400 Bad Request. Jos salasana on lyhyempi kuin 8 merkkiä nousee poikkeus: Internal Server Error 500 |
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 |
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.
API | Description |
---|---|
GET osapuolitiedot/osapuolet/{id} |
!!!Vain sisäiseen käyttöön!!! Hakee osapuolen id:llä. |
POST osapuolitiedot/osapuolet/hakusana?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen} |
!!!Vain sisäiseen käyttöön!!! 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 |
!!!Vain sisäiseen käyttöön!!! Päivittää osapuolen tietoja metatietojen perusteella. |
OsapuolimetanimiApi
API | Description |
---|---|
GET osapuolitiedot/metanimet/kentat |
!!!Vain sisäiseen käyttöön!!! Hakee osapuolen kenttien metanimet. |
OsapuoliOikeudet
API | Description |
---|---|
GET osapuolet/oikeudet/all |
Palauttaa kaikki ne oikeudet jotka käyttäjälle on myönnetty |
OsapuoliOikeudetApi
API | Description |
---|---|
GET osapuolitiedot/oikeudet/mine |
!!!Vain sisäiseen käyttöön!!! Palauttaa kaikki käyttäjän oikeudet. |
OsapuoliYhteydenotto
API | Description |
---|---|
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 |
OsapuoliYhteydenottoApi
API | Description |
---|---|
GET osapuolitiedot/yhteydenotot/{id} |
!!!Vain sisäiseen käyttöön!!! Palauttaa yhteydentoton tiedot id:llä |
POST osapuolitiedot/yhteydenotot/add |
!!!Vain sisäiseen käyttöön!!! Lisää osapuolen yhteydenoton |
GET osapuolitiedot/yhteydenotot/osapuoli/{osapuoliId} |
!!!Vain sisäiseen käyttöön!!! Palauttaa osapuolen yhteydenottojen tiedot |
GET osapuolitiedot/yhteydenotot/liitteet/{liiteId} |
!!!Vain sisäiseen käyttöön!!! Palauttaa yhteydentoton liitteen. |
POST osapuolitiedot/yhteydenotot/{id}/asetaluetuksi?tunnus={tunnus} |
!!!Vain sisäiseen käyttöön!!! Asettaa yhteydenoton tilaan luettu. |
POST osapuolitiedot/yhteydenotot/yhteydenotot/{yhteydenotto_id}/asetakasitellyksi?id={id}&tunnus={tunnus} |
!!!Vain sisäiseen käyttöön!!! Asettaa yhteydenoton tilaan käsitelty. |
GET osapuolitiedot/yhteydenotot/luokittelut |
!!!Vain sisäiseen käyttöön!!! Palauttaa listan yhteydenottojen luokittelu-vaihtoehdoista |
GET osapuolitiedot/yhteydenotot/viestiketjut/{viestiketjuId} |
!!!Vain sisäiseen käyttöön!!! Palauttaa listan yhteudenotoista viestiketjuid:n perusteella |
OsapuoliyhteydetApi
API | Description |
---|---|
POST osapuoliyhteydet/selaa |
!!!Vain sisäiseen käyttöön!!! Hakee osapuolien yhteyksiä. |
RemontitApi
Tampuurin kunnossapidon remonttien palvelurajapinta
API | Description |
---|---|
POST kunnossapito/remontit/hae |
!!!Vain sisäiseen käyttöön!!! Palauttaa kustannuspaikan remontteja hakuparametrien perusteella. Huom! Ei ota kantaa oikeuksiin. |
GET kunnossapito/remontit/{remontti_id} |
!!!Vain sisäiseen käyttöön!!! Palauttaa id:tä vastaavan remontin. |
Reskontra
API | Description |
---|---|
GET reskontra/indeksit?tilannepvm={tilannepvm} |
Tilannepäivänä voimassaolevien indeksien haku. Tilannepäivää verrataan indeksin julkaisupäivään. |
Saunavuoro
Saunavuorojen operaatiot.
API | Description |
---|---|
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 kustannuspaikan alla olevien kohteiden kaikki varaukset. |
GET saunavuorot?kohde_id={kohde_id} |
Palauttaa kohteen kaikki varaukset. |
GET saunavuorot?varaaja_kohde_id={varaaja_kohde_id} |
Palauttaa kohteen nimissä tehdyt saunavuorovaraukset. |
GET saunavuorot?varaaja_osapuoli_id={varaaja_osapuoli_id} |
Palauttaa henkilön nimissä tehdyt saunavuorovaraukset. |
DELETE saunavuorot/{saunavuoro_id} |
Poistaa saunavuoron järjestelmästä. |
Sopimus
API | Description |
---|---|
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 |
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 |
Tarjous
Toiminnot tarjousten käsittelyihin ja hakuihin
API | Description |
---|---|
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. |
POST tarjoukset/{tarjous_id}/hylkaa |
Hylkää asuntotarjouksen |
TarkastajanKalenteri
API | Description |
---|---|
GET kunnossapito/tarkastajankalenteri/vapaatajat?KohdeId={KohdeId}&Alkaa={Alkaa}&Paattyy={Paattyy} |
Etsii varattavissa olevia aikoja |
POST kunnossapito/tarkastajankalenteri/varaukset/lisaa |
Lisää ajanvarauksen |
Tarkastus
Tarkastuksen yleiset toiminnot
API | Description |
---|---|
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.
API | Description |
---|---|
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 |
TarkastusLiitteet
Tarkastuksien liitepalvelut
API | Description |
---|---|
GET tarkastukset/{id}/liitteet |
Hakee tarkastuksen liitteet. |
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. |
TarkastusLisatiedot
Tarkastuksien kohdetyyppi neutraalin palvelin Lisätietojen controlleri Lisätietojen palvelut sekä toissijaisien tietojen palvelut
API | Description |
---|---|
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
API | Description |
---|---|
GET tarkastukset/{Id}/loki?Offset={Offset}&Limit={Limit} |
Palauttaa tarkastuksen lokin sivutettuna. |
TarkastusMallit
Tarkastuksen malleihin liittyvät palvelut
API | Description |
---|---|
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.
API | Description |
---|---|
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.
API | Description |
---|---|
GET tarkastukset/asetukset |
Palauttaa tarkastus X käyttämät asetukset |
GET tarkastukset/valinnat |
Tarkastus valintalistat. |
Tehtava
Tarjoaa tehtävärekisterin palveluita.
API | Description |
---|---|
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
API | Description |
---|---|
GET testit/{testi_id} |
Testimetodi WebApin savutestaamiselle |
Tiedosto
API | Description |
---|---|
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. |
Tiedostoloki
Tiedostohistorian palvelu.
API | Description |
---|---|
GET tiedostoloki/selaa/{tyyppi}?Liitetyyppi={Liitetyyppi}&AikaleimaAlku={AikaleimaAlku}&AikaleimaLoppu={AikaleimaLoppu}&Offset={Offset}&Limit={Limit} |
Hakee kokoelman dokumenttimuutoksia. |
Toiminnanohjaus
API | Description |
---|---|
POST toiminnanohjaus/selaa |
Hakee kokouksia hakuehdoilla. |
POST toiminnanohjaus/{tehtavaid}/allekirjoituksentila/kesken |
Asettaa allekirjoituksen tilaan "KESKEN" |
POST toiminnanohjaus/{tehtavaid}/allekirjoituksentila/hyvaksy |
Asettaa allekirjoituksen tilaan "HYVÄKSYTTY" |
POST toiminnanohjaus/{tehtavaid}/allekirjoituksentila/hylkaa |
Asettaa allekirjoituksen tilaan "HYLÄTTY" |
POST toiminnanohjaus/{tehtavaid}/allekirjoituksentila/peruuta |
Asettaa allekirjoituksen tilaan "PERUUTETTU" |
GET toiminnanohjaus/{tehtavaid}/liitteet |
Hakee tehtävän liitteet. |
GET toiminnanohjaus/liitteet/{liiteid}/tiedosto/viimeisin |
Hakee tehtävän liiteen uusimman tiedoston. |
POST toiminnanohjaus/{tehtavaid}/liitteet/lisaa |
Lisää tehtävälle liitteen. |
POST toiminnanohjaus/liitteet/{liiteid}/lisaa |
Lisää uuden tiedostoversion liitteelle. |
Toimintakertomus
Toimintakertomusten toiminnot
API | Description |
---|---|
GET toimintakertomukset/{id} |
Palauttaa toimintakertomuksen |
GET toimintakertomukset/kohteet/{id}/kasitellyt |
Palauttaa kohteen käsitellyt toimintakertomukset |
GET toimintakertomukset/kohteet/{ytunnus}/kasitellyt |
Palauttaa kohteen käsitellyt toimintakertomukset |
POST toimintakertomukset/{id}/valmiiksi |
Asettaa toimintakertomuksen valmiiksi |
POST toimintakertomukset/{id}/lomake/update |
Päivittää toimintakertomukselle lomakepohjan |
GET toimintakertomukset/{id}/lomake |
Palauttaa toimintakertomuksen lomakepohjan |
Tunnus
API | Description |
---|---|
GET tunnukset/tarkistakirjautuminen |
Palauttaa kutsun kirjautumistiedot. |
Tuoterekisteri
API | Description |
---|---|
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/toimittaja/{toimittajaid}/tuotteet |
Hakee toimittajan tuotekatalogin |
TyonsuorittajaApi
API | Description |
---|---|
GET osapuolitiedot/tyonsuorittajat/kohde/{kohdeId} |
!!!Vain sisäiseen käyttöön!!! Hakee kohteen tyonsuorittajat, eli yritykset ja ne henkilöt, joilla on käyttäjätunnukset. |
POST osapuolitiedot/tyonsuorittajat/hakusana/{hakusana} |
!!!Vain sisäiseen käyttöön!!! Hakee tyonsuorittajat, eli yritykset ja ne henkilöt, joilla on käyttäjätunnukset hakusanan perusteella. |
Viestinta
API | Description |
---|---|
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.
API | Description |
---|---|
GET yhteydet/osapuoli/{id} |
!!!Vain sisäiseen käyttöön!!! Palauttaa osapuolen voimassa olevat yhteydet. |
YritysApi
Yritystietoihin erikoistunut kontrolleri. Osapuolien toimintoja käsitellään yrityksiin erikoistuneessa HenkiloApiController-luokassa. Henkilöiden toimintoja käsitellään yrityksiin erikoistuneessa HenkiloApiController-luokassa.
API | Description |
---|---|
GET osapuolitiedot/yritykset/{id} |
!!!Vain sisäiseen käyttöön!!! Hakee yrityksen id:llä. |
POST osapuolitiedot/yritykset/hakusana?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen} |
!!!Vain sisäiseen käyttöön!!! Palauttaa kokoelman yrityksiä, joiden määrätty parametri vastaa annettuun hakusanaan. Yrityksillä on "Parametrit"-kokoelma, mutta kokoelma on aina tyhjä. |
POST osapuolitiedot/yritykset/selaa |
!!!Vain sisäiseen käyttöön!!! Selaa yrityksiä, vastaus sivutetusti. |
POST osapuolitiedot/yritykset/create |
!!!Vain sisäiseen käyttöön!!! Lisää yrityksen. |