POST koosteet/osapuolitiedot/sopimustiedot/hae

Palauttaa osapuolen sopimusten tietoja koottuna useasta palvelusta.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Hetu	Osapuolen Suomalainen henkilötunnus.	string	RequiredString length: inclusive between 11 and 11

Request Formats

application/json, text/json

Sample:

{
  "Hetu": "sample string 1"
}

application/xml, text/xml

Sample:

<ApiKoosteOsapuolenSopimustiedotRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Koosteet">
  <Hetu>sample string 1</Hetu>
</ApiKoosteOsapuolenSopimustiedotRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiKoosteOsapuolenSopimustiedotResponse

Name	Type	Additional information
SopimusId	integer	None.
AlkuPvm	date	None.
LoppuPvm	date	None.
Saldo	decimal number	None.
SaldoEdellinenKuukausi	decimal number	None.
JalkiperinnanSaldo	decimal number	None.
TarkastettuPvm	date	None.
Kohde	ApiKohde	None.
Osapuoli	ApiAspaSopimusOsapuoliResponse	None.
Huomiot	Collection of ApiOsapuoliHuomioResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "SopimusId": 1,
  "AlkuPvm": "2025-04-19T21:19:49.3340717+03:00",
  "LoppuPvm": "2025-04-19T21:19:49.3340717+03:00",
  "Saldo": 3.0,
  "SaldoEdellinenKuukausi": 4.0,
  "JalkiperinnanSaldo": 5.0,
  "TarkastettuPvm": "2025-04-19T21:19:49.3340717+03:00",
  "Kohde": {
    "Id": 1,
    "KohdeTyyppi": "sample string 2",
    "PaatasonId": 3,
    "ParentId": 1,
    "Nimi": "sample string 4",
    "Luotu": "2025-04-19T21:19:49.3340717+03:00",
    "Lisatietoja": "sample string 5",
    "Polku": "sample string 6",
    "PoistettuPvm": "2025-04-19T21:19:49.3340717+03:00",
    "Paikkatieto": {
      "Latitude": 1.0,
      "Longitude": 2.0
    },
    "Parametrit": [
      {
        "PtypeId": 1,
        "Nimi": "sample string 2",
        "Arvo": "sample string 3",
        "ArvonTieto": "sample string 4",
        "Metanimi": "sample string 5"
      },
      {
        "PtypeId": 1,
        "Nimi": "sample string 2",
        "Arvo": "sample string 3",
        "ArvonTieto": "sample string 4",
        "Metanimi": "sample string 5"
      }
    ]
  },
  "Osapuoli": {
    "OsapuoliId": 1,
    "Sopija": true,
    "Maksaja": true,
    "Asukas": true,
    "MaksuvelvollisuusPaattyy": "2025-04-19T21:19:49.3340717+03:00",
    "Edunvalvoja": true,
    "AllekirjoitusStatus": 1,
    "AllekirjoitusAikaleima": "2025-04-19T21:19:49.3340717+03:00",
    "Alivuokralainen": true,
    "PoistoPvm": "2025-04-19T21:19:49.3340717+03:00",
    "IrtisanominenVahvistettuPvm": "2025-04-19T21:19:49.3340717+03:00",
    "IrtisanoutunutPvm": "2025-04-19T21:19:49.3340717+03:00"
  },
  "Huomiot": [
    {
      "Luokka": "sample string 1",
      "Kuvaus": "sample string 2",
      "Lisatty": "2025-04-19T21:19:49.3340717+03:00",
      "Eraantyy": "2025-04-19T21:19:49.3340717+03:00"
    },
    {
      "Luokka": "sample string 1",
      "Kuvaus": "sample string 2",
      "Lisatty": "2025-04-19T21:19:49.3340717+03:00",
      "Eraantyy": "2025-04-19T21:19:49.3340717+03:00"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiKoosteOsapuolenSopimustiedotResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Koosteet">
  <AlkuPvm xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-19T18:19:49.3340717Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>180</d2p1:OffsetMinutes>
  </AlkuPvm>
  <Huomiot xmlns:d2p1="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Osapuolirekisteri">
    <d2p1:ApiOsapuoliHuomioResponse>
      <d2p1:Eraantyy>2025-04-19T21:19:49.3340717+03:00</d2p1:Eraantyy>
      <d2p1:Kuvaus>sample string 2</d2p1:Kuvaus>
      <d2p1:Lisatty>2025-04-19T21:19:49.3340717+03:00</d2p1:Lisatty>
      <d2p1:Luokka>sample string 1</d2p1:Luokka>
    </d2p1:ApiOsapuoliHuomioResponse>
    <d2p1:ApiOsapuoliHuomioResponse>
      <d2p1:Eraantyy>2025-04-19T21:19:49.3340717+03:00</d2p1:Eraantyy>
      <d2p1:Kuvaus>sample string 2</d2p1:Kuvaus>
      <d2p1:Lisatty>2025-04-19T21:19:49.3340717+03:00</d2p1:Lisatty>
      <d2p1:Luokka>sample string 1</d2p1:Luokka>
    </d2p1:ApiOsapuoliHuomioResponse>
  </Huomiot>
  <JalkiperinnanSaldo>5</JalkiperinnanSaldo>
  <Kohde xmlns:d2p1="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Kohderekisteri">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:KohdeTyyppi>sample string 2</d2p1:KohdeTyyppi>
    <d2p1:Lisatietoja>sample string 5</d2p1:Lisatietoja>
    <d2p1:Luotu>2025-04-19T21:19:49.3340717+03:00</d2p1:Luotu>
    <d2p1:Nimi>sample string 4</d2p1:Nimi>
    <d2p1:PaatasonId>3</d2p1:PaatasonId>
    <d2p1:Paikkatieto xmlns:d3p1="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract">
      <d3p1:Latitude>1</d3p1:Latitude>
      <d3p1:Longitude>2</d3p1:Longitude>
    </d2p1:Paikkatieto>
    <d2p1:Parametrit>
      <d2p1:ApiKohdeParametri>
        <d2p1:Arvo>sample string 3</d2p1:Arvo>
        <d2p1:ArvonTieto>sample string 4</d2p1:ArvonTieto>
        <d2p1:Metanimi>sample string 5</d2p1:Metanimi>
        <d2p1:Nimi>sample string 2</d2p1:Nimi>
        <d2p1:PtypeId>1</d2p1:PtypeId>
      </d2p1:ApiKohdeParametri>
      <d2p1:ApiKohdeParametri>
        <d2p1:Arvo>sample string 3</d2p1:Arvo>
        <d2p1:ArvonTieto>sample string 4</d2p1:ArvonTieto>
        <d2p1:Metanimi>sample string 5</d2p1:Metanimi>
        <d2p1:Nimi>sample string 2</d2p1:Nimi>
        <d2p1:PtypeId>1</d2p1:PtypeId>
      </d2p1:ApiKohdeParametri>
    </d2p1:Parametrit>
    <d2p1:ParentId>1</d2p1:ParentId>
    <d2p1:PoistettuPvm>2025-04-19T21:19:49.3340717+03:00</d2p1:PoistettuPvm>
    <d2p1:Polku>sample string 6</d2p1:Polku>
  </Kohde>
  <LoppuPvm xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-19T18:19:49.3340717Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>180</d2p1:OffsetMinutes>
  </LoppuPvm>
  <Osapuoli xmlns:d2p1="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Asiakaspalvelu">
    <d2p1:Alivuokralainen>true</d2p1:Alivuokralainen>
    <d2p1:AllekirjoitusAikaleima>2025-04-19T21:19:49.3340717+03:00</d2p1:AllekirjoitusAikaleima>
    <d2p1:AllekirjoitusStatus>Hyvaksytty</d2p1:AllekirjoitusStatus>
    <d2p1:Asukas>true</d2p1:Asukas>
    <d2p1:Edunvalvoja>true</d2p1:Edunvalvoja>
    <d2p1:IrtisanominenVahvistettuPvm>2025-04-19T21:19:49.3340717+03:00</d2p1:IrtisanominenVahvistettuPvm>
    <d2p1:IrtisanoutunutPvm>2025-04-19T21:19:49.3340717+03:00</d2p1:IrtisanoutunutPvm>
    <d2p1:Maksaja>true</d2p1:Maksaja>
    <d2p1:MaksuvelvollisuusPaattyy>2025-04-19T21:19:49.3340717+03:00</d2p1:MaksuvelvollisuusPaattyy>
    <d2p1:OsapuoliId>1</d2p1:OsapuoliId>
    <d2p1:PoistoPvm>2025-04-19T21:19:49.3340717+03:00</d2p1:PoistoPvm>
    <d2p1:Sopija>true</d2p1:Sopija>
  </Osapuoli>
  <Saldo>3</Saldo>
  <SaldoEdellinenKuukausi>4</SaldoEdellinenKuukausi>
  <SopimusId>1</SopimusId>
  <TarkastettuPvm>2025-04-19T21:19:49.3340717+03:00</TarkastettuPvm>
</ApiKoosteOsapuolenSopimustiedotResponse>