POST aurauspaivakirja/tapahtuma/hae
Hakee Aurauspäiväkirja tapahtumat hakuehdoilla.
Request Information
URI Parameters
None.
Body Parameters
Hakuehdot. ApiAurauspaivakirjaTapahtumaQueryRequestName | Description | Type | Additional information |
---|---|---|---|
KohdeId | Kohteen id, jolta auraus tapahtumat haetaan. | integer | None. |
Alkuaika | Alkuaika, jonka mukaan tapahtumat haetaan. | date | None. |
Loppuaika | Loppuaika, jonka mukaan tapahtumat haetaan. | date | None. |
TapahtumaTyyppi | TapahtumaTyypin ID, jonka mukaan tapahtumat haetaan. | integer | None. |
KirjaajaId | Kirjaajan id, jolta auraus tapahtumat haetaan. | integer | None. |
Offset | Kertoo kuinka monta hakutulosta hypätään yli. | integer | None. |
Limit | Kertoo kuinka monta hakutulosta järjestelmä korkeintaan palauttaa. | integer | None. |
VainAvoimet | Määrittää haetaanko vain avoimet tapahtumat | boolean | None. |
Sort | Tieto jonka mukaan tulosjoukko järjestetään. | ApiAurauspaivakirjaTapahtumaSortField | None. |
Order | Järjestyksen suunta. | ApiSortOrder | None. |
Request Formats
application/json, text/json
Sample:
{ "KohdeId": 1, "Alkuaika": "2025-04-19T21:01:44.7300447+03:00", "Loppuaika": "2025-04-19T21:01:44.7300447+03:00", "TapahtumaTyyppi": 1, "KirjaajaId": 1, "Offset": 1, "Limit": 1, "VainAvoimet": true, "Sort": "Kirjausaika", "Order": "asc" }
application/xml, text/xml
Sample:
<ApiAurauspaivakirjaTapahtumaQueryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract"> <Alkuaika>2025-04-19T21:01:44.7300447+03:00</Alkuaika> <KirjaajaId>1</KirjaajaId> <KohdeId>1</KohdeId> <Limit>1</Limit> <Loppuaika>2025-04-19T21:01:44.7300447+03:00</Loppuaika> <Offset>1</Offset> <Order>asc</Order> <Sort>Kirjausaika</Sort> <TapahtumaTyyppi>1</TapahtumaTyyppi> <VainAvoimet>true</VainAvoimet> </ApiAurauspaivakirjaTapahtumaQueryRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Lista aurauspäiväkirja tapahtumiaPagingMetadataResponseOfApiAurauspaivakirjaTapahtumaResponse
Name | Description | Type | Additional information |
---|---|---|---|
Offset | integer | None. | |
Limit | integer | None. | |
Total | integer | None. | |
Items | Collection of ApiAurauspaivakirjaTapahtumaResponse | None. |
Response Formats
application/json, text/json
Sample:
{ "Offset": 1, "Limit": 2, "Total": 3, "Items": [ { "Id": 1, "KohdeId": 2, "KohdeNimi": "sample string 3", "Aloitusaika": "2025-04-19T21:01:44.7300447+03:00", "Lopetusaika": "2025-04-19T21:01:44.7300447+03:00", "Pvm": "2025-04-19T21:01:44.7300447+03:00", "Tapahtumatyyppi": 6, "Kuvaus": "sample string 7", "Tyonsuorittaja": 8, "TyonsuorittajaNimi": "sample string 9", "kommentit": [ { "KommentoijaId": 1, "KommentoijaNimi": "sample string 2", "Pvm": "2025-04-19T21:01:44.7300447+03:00", "Viesti": "sample string 4" }, { "KommentoijaId": 1, "KommentoijaNimi": "sample string 2", "Pvm": "2025-04-19T21:01:44.7300447+03:00", "Viesti": "sample string 4" } ] }, { "Id": 1, "KohdeId": 2, "KohdeNimi": "sample string 3", "Aloitusaika": "2025-04-19T21:01:44.7300447+03:00", "Lopetusaika": "2025-04-19T21:01:44.7300447+03:00", "Pvm": "2025-04-19T21:01:44.7300447+03:00", "Tapahtumatyyppi": 6, "Kuvaus": "sample string 7", "Tyonsuorittaja": 8, "TyonsuorittajaNimi": "sample string 9", "kommentit": [ { "KommentoijaId": 1, "KommentoijaNimi": "sample string 2", "Pvm": "2025-04-19T21:01:44.7300447+03:00", "Viesti": "sample string 4" }, { "KommentoijaId": 1, "KommentoijaNimi": "sample string 2", "Pvm": "2025-04-19T21:01:44.7300447+03:00", "Viesti": "sample string 4" } ] } ] }
application/xml, text/xml
Sample:
<PagingMetadataResponseOfApiAurauspaivakirjaTapahtumaResponse5WcbX_PsP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract"> <Items> <ApiAurauspaivakirjaTapahtumaResponse> <Aloitusaika>2025-04-19T21:01:44.7300447+03:00</Aloitusaika> <Id>1</Id> <KohdeId>2</KohdeId> <KohdeNimi>sample string 3</KohdeNimi> <Kuvaus>sample string 7</Kuvaus> <Lopetusaika>2025-04-19T21:01:44.7300447+03:00</Lopetusaika> <Pvm>2025-04-19T21:01:44.7300447+03:00</Pvm> <Tapahtumatyyppi>6</Tapahtumatyyppi> <Tyonsuorittaja>8</Tyonsuorittaja> <TyonsuorittajaNimi>sample string 9</TyonsuorittajaNimi> <kommentit xmlns:d4p1="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Aurauspaivakirja"> <d4p1:AurauspaivakirjaKommentti> <d4p1:KommentoijaId>1</d4p1:KommentoijaId> <d4p1:KommentoijaNimi>sample string 2</d4p1:KommentoijaNimi> <d4p1:Pvm>2025-04-19T21:01:44.7300447+03:00</d4p1:Pvm> <d4p1:Viesti>sample string 4</d4p1:Viesti> </d4p1:AurauspaivakirjaKommentti> <d4p1:AurauspaivakirjaKommentti> <d4p1:KommentoijaId>1</d4p1:KommentoijaId> <d4p1:KommentoijaNimi>sample string 2</d4p1:KommentoijaNimi> <d4p1:Pvm>2025-04-19T21:01:44.7300447+03:00</d4p1:Pvm> <d4p1:Viesti>sample string 4</d4p1:Viesti> </d4p1:AurauspaivakirjaKommentti> </kommentit> </ApiAurauspaivakirjaTapahtumaResponse> <ApiAurauspaivakirjaTapahtumaResponse> <Aloitusaika>2025-04-19T21:01:44.7300447+03:00</Aloitusaika> <Id>1</Id> <KohdeId>2</KohdeId> <KohdeNimi>sample string 3</KohdeNimi> <Kuvaus>sample string 7</Kuvaus> <Lopetusaika>2025-04-19T21:01:44.7300447+03:00</Lopetusaika> <Pvm>2025-04-19T21:01:44.7300447+03:00</Pvm> <Tapahtumatyyppi>6</Tapahtumatyyppi> <Tyonsuorittaja>8</Tyonsuorittaja> <TyonsuorittajaNimi>sample string 9</TyonsuorittajaNimi> <kommentit xmlns:d4p1="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Aurauspaivakirja"> <d4p1:AurauspaivakirjaKommentti> <d4p1:KommentoijaId>1</d4p1:KommentoijaId> <d4p1:KommentoijaNimi>sample string 2</d4p1:KommentoijaNimi> <d4p1:Pvm>2025-04-19T21:01:44.7300447+03:00</d4p1:Pvm> <d4p1:Viesti>sample string 4</d4p1:Viesti> </d4p1:AurauspaivakirjaKommentti> <d4p1:AurauspaivakirjaKommentti> <d4p1:KommentoijaId>1</d4p1:KommentoijaId> <d4p1:KommentoijaNimi>sample string 2</d4p1:KommentoijaNimi> <d4p1:Pvm>2025-04-19T21:01:44.7300447+03:00</d4p1:Pvm> <d4p1:Viesti>sample string 4</d4p1:Viesti> </d4p1:AurauspaivakirjaKommentti> </kommentit> </ApiAurauspaivakirjaTapahtumaResponse> </Items> <Limit>2</Limit> <Offset>1</Offset> <Total>3</Total> </PagingMetadataResponseOfApiAurauspaivakirjaTapahtumaResponse5WcbX_PsP>