POST sopimukset/{sopimusId}/tavoitteet/hae

Palauttaa sopimuksen tavoitteet pyydetyiltä kausilta. Yhdessä haussa palautetaan maksimissaan kolmen vuoden tavoitteet.

Request Information

URI Parameters

Name	Description	Type	Additional information
sopimusId		integer	Required

Body Parameters

Aikaväli voi olla maksimissaan kolmen vuoden mittainen. Yhden kauden tavoitteet saa antamalla Alkaa ja Loppuu parametreihin samat tiedot. ApiVuosiKuukausiAikavaliRequest

Name	Description	Type	Additional information
Alkaa	Aikavälin alku	ApiVuosiKuukausi	Required
Loppuu	Aikavälin loppu	ApiVuosiKuukausi	Required

Request Formats

application/json, text/json

Sample:

{
  "Alkaa": {
    "Kuukausi": 1,
    "Vuosi": 2
  },
  "Loppuu": {
    "Kuukausi": 1,
    "Vuosi": 2
  }
}

application/xml, text/xml

Sample:

<ApiVuosiKuukausiAikavaliRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract">
  <Alkaa>
    <Kuukausi>1</Kuukausi>
    <Vuosi>2</Vuosi>
  </Alkaa>
  <Loppuu>
    <Kuukausi>1</Kuukausi>
    <Vuosi>2</Vuosi>
  </Loppuu>
</ApiVuosiKuukausiAikavaliRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ApiTavoite

Name	Type	Additional information
Maksulaji	string	Required
MaksulajiId	integer	Required
Erapaiva	date	Required
Laskupaiva	date	None.
Summa	decimal number	Required
Alkuaika	date	Required
Loppuaika	date	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "Maksulaji": "sample string 1",
    "MaksulajiId": 2,
    "Erapaiva": "2024-05-06T02:50:05.946242+03:00",
    "Laskupaiva": "2024-05-06T02:50:05.946242+03:00",
    "Summa": 4.0,
    "Alkuaika": "2024-05-06T02:50:05.946242+03:00",
    "Loppuaika": "2024-05-06T02:50:05.946242+03:00"
  },
  {
    "Maksulaji": "sample string 1",
    "MaksulajiId": 2,
    "Erapaiva": "2024-05-06T02:50:05.946242+03:00",
    "Laskupaiva": "2024-05-06T02:50:05.946242+03:00",
    "Summa": 4.0,
    "Alkuaika": "2024-05-06T02:50:05.946242+03:00",
    "Loppuaika": "2024-05-06T02:50:05.946242+03:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiTavoite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Asiakaspalvelu">
  <ApiTavoite>
    <Alkuaika>2024-05-06T02:50:05.946242+03:00</Alkuaika>
    <Erapaiva>2024-05-06T02:50:05.946242+03:00</Erapaiva>
    <Laskupaiva>2024-05-06T02:50:05.946242+03:00</Laskupaiva>
    <Loppuaika>2024-05-06T02:50:05.946242+03:00</Loppuaika>
    <Maksulaji>sample string 1</Maksulaji>
    <MaksulajiId>2</MaksulajiId>
    <Summa>4</Summa>
  </ApiTavoite>
  <ApiTavoite>
    <Alkuaika>2024-05-06T02:50:05.946242+03:00</Alkuaika>
    <Erapaiva>2024-05-06T02:50:05.946242+03:00</Erapaiva>
    <Laskupaiva>2024-05-06T02:50:05.946242+03:00</Laskupaiva>
    <Loppuaika>2024-05-06T02:50:05.946242+03:00</Loppuaika>
    <Maksulaji>sample string 1</Maksulaji>
    <MaksulajiId>2</MaksulajiId>
    <Summa>4</Summa>
  </ApiTavoite>
</ArrayOfApiTavoite>