POST osapuolitiedot/osapuolet/hae
Hakee arkistoimattomat osapuolet id:illä ja parametrit niille metanimillä tai id:illä.
Request Information
URI Parameters
None.
Body Parameters
Kutsun malli ApiOsapuoletRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OsapuoliIdt | Collection of integer | Required | |
| Metanimet | Collection of string | None. | |
| ParametriIdt | Collection of integer | None. |
Request Formats
application/json, text/json
Sample:
{
"OsapuoliIdt": [
1,
2
],
"Metanimet": [
"sample string 1",
"sample string 2"
],
"ParametriIdt": [
1,
2
]
}
application/xml, text/xml
Sample:
<ApiOsapuoletRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Osapuolirekisteri">
<Metanimet xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Metanimet>
<OsapuoliIdt xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</OsapuoliIdt>
<ParametriIdt xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ParametriIdt>
</ApiOsapuoletRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ApiOsapuoliResponseModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | Osapuolen Id | integer | None. |
| YritysId | Osapuolen yrityksen Id | integer | None. |
| Nimi | Osapuolen nimi | string | None. |
| Turvakielto | Henkilöosapuolen turvakieltotieto | boolean | None. |
| Osapuolityyppi | Enumeraattori joka kertoo osapuolen tyypin, Henkilö tai Yritys | ApiOsapuoliTyyppi | None. |
| Tunnistautuminen | Osapuolen tunnistautumistiedot. | ApiOsapuoliTunnistautuminenResponse | None. |
| Parametrit | Osapuolen parametrikokoelma. | Collection of ApiOsapuoliParametriResponse | None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": 1,
"YritysId": 1,
"Nimi": "sample string 2",
"Turvakielto": true,
"Osapuolityyppi": "Henkilo",
"Tunnistautuminen": {
"Tyyppi": "Tupas",
"Tunnistettu": "2025-11-05T11:42:11.2054608+02:00"
},
"Parametrit": [
{
"Id": 1,
"Nimi": "sample string 2",
"MetaNimi": "sample string 3",
"Arvo": "sample string 4"
},
{
"Id": 1,
"Nimi": "sample string 2",
"MetaNimi": "sample string 3",
"Arvo": "sample string 4"
}
]
},
{
"Id": 1,
"YritysId": 1,
"Nimi": "sample string 2",
"Turvakielto": true,
"Osapuolityyppi": "Henkilo",
"Tunnistautuminen": {
"Tyyppi": "Tupas",
"Tunnistettu": "2025-11-05T11:42:11.2054608+02:00"
},
"Parametrit": [
{
"Id": 1,
"Nimi": "sample string 2",
"MetaNimi": "sample string 3",
"Arvo": "sample string 4"
},
{
"Id": 1,
"Nimi": "sample string 2",
"MetaNimi": "sample string 3",
"Arvo": "sample string 4"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfApiOsapuoliResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Osapuolirekisteri">
<ApiOsapuoliResponseModel>
<Id>1</Id>
<Nimi>sample string 2</Nimi>
<Osapuolityyppi>Henkilo</Osapuolityyppi>
<Parametrit>
<ApiOsapuoliParametriResponse>
<Arvo>sample string 4</Arvo>
<Id>1</Id>
<MetaNimi>sample string 3</MetaNimi>
<Nimi>sample string 2</Nimi>
</ApiOsapuoliParametriResponse>
<ApiOsapuoliParametriResponse>
<Arvo>sample string 4</Arvo>
<Id>1</Id>
<MetaNimi>sample string 3</MetaNimi>
<Nimi>sample string 2</Nimi>
</ApiOsapuoliParametriResponse>
</Parametrit>
<Tunnistautuminen>
<Tunnistettu>2025-11-05T11:42:11.2054608+02:00</Tunnistettu>
<Tyyppi>Tupas</Tyyppi>
</Tunnistautuminen>
<Turvakielto>true</Turvakielto>
<YritysId>1</YritysId>
</ApiOsapuoliResponseModel>
<ApiOsapuoliResponseModel>
<Id>1</Id>
<Nimi>sample string 2</Nimi>
<Osapuolityyppi>Henkilo</Osapuolityyppi>
<Parametrit>
<ApiOsapuoliParametriResponse>
<Arvo>sample string 4</Arvo>
<Id>1</Id>
<MetaNimi>sample string 3</MetaNimi>
<Nimi>sample string 2</Nimi>
</ApiOsapuoliParametriResponse>
<ApiOsapuoliParametriResponse>
<Arvo>sample string 4</Arvo>
<Id>1</Id>
<MetaNimi>sample string 3</MetaNimi>
<Nimi>sample string 2</Nimi>
</ApiOsapuoliParametriResponse>
</Parametrit>
<Tunnistautuminen>
<Tunnistettu>2025-11-05T11:42:11.2054608+02:00</Tunnistettu>
<Tyyppi>Tupas</Tyyppi>
</Tunnistautuminen>
<Turvakielto>true</Turvakielto>
<YritysId>1</YritysId>
</ApiOsapuoliResponseModel>
</ArrayOfApiOsapuoliResponseModel>