GET osapuolet?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen}
Palauttaa kokoelman osapuolia, joiden määrätty parametri vastaa annettuun hakusanaan.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Hakusana | Merkkijono, jonka mukaan haku tehdään. | string | RequiredString length: inclusive between 1 and 50 |
| Metanimi | Metanimi, johon haku kohdistetaan. | string | Required |
| Tasmalleen | Lippu, joka kertoo pitääkö parametrin vastata täsmälleen annettua hakusanaa vai riittääkö, että hakusana sisältyy arvoon. Oletusarvoisesti haetaan niin, että merkkijono sisältyy arvoon. | boolean | None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ApiOsapuoliPerustiedot
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | Osapuolen Id | integer | None. |
| YritysId | Osapuolen yrityksen Id | integer | None. |
| Osapuolityyppi | Osapuolen tyyppi | ApiOsapuoliTyyppiInt | None. |
| Nimi | Henkilöosapuolen koko nimi tai yritysosapuolen nimi | string | None. |
| Etunimi | Henkilöosapuolen etunimi | string | None. |
| Sukunimi | Henkilöosapuolen sukunimi | string | None. |
| Katuosoite | string | None. | |
| Postinumero | string | None. | |
| Postitoimipaikka | string | None. | |
| Puhelin | Puhelinnumero | string | None. |
| Matkapuhelin | Matkapuhelinnumero | string | None. |
| Sahkoposti | Sähköpostiosoite | string | None. |
| Tunnus | Yritys osapuolen Y-tunnus tai henkilöosapuolen hetu | string | None. |
| Turvakielto | Henkilöosapuolen turvakieltotieto | boolean | None. |
| Tunnistautuminen | Osapuolen tunnistautumistiedot | ApiOsapuoliTunnistautuminenResponse | None. |
| Arkistoitu | Aikaleima osapuolen arkistointihetkestä | date | None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": 1,
"YritysId": 1,
"Osapuolityyppi": 0,
"Nimi": "sample string 2",
"Etunimi": "sample string 3",
"Sukunimi": "sample string 4",
"Katuosoite": "sample string 5",
"Postinumero": "sample string 6",
"Postitoimipaikka": "sample string 7",
"Puhelin": "sample string 8",
"Matkapuhelin": "sample string 9",
"Sahkoposti": "sample string 10",
"Tunnus": "sample string 11",
"Turvakielto": true,
"Tunnistautuminen": {
"Tyyppi": "Tupas",
"Tunnistettu": "2025-11-05T11:40:20.1926513+02:00"
},
"Arkistoitu": "2025-11-05T11:40:20.1926513+02:00"
},
{
"Id": 1,
"YritysId": 1,
"Osapuolityyppi": 0,
"Nimi": "sample string 2",
"Etunimi": "sample string 3",
"Sukunimi": "sample string 4",
"Katuosoite": "sample string 5",
"Postinumero": "sample string 6",
"Postitoimipaikka": "sample string 7",
"Puhelin": "sample string 8",
"Matkapuhelin": "sample string 9",
"Sahkoposti": "sample string 10",
"Tunnus": "sample string 11",
"Turvakielto": true,
"Tunnistautuminen": {
"Tyyppi": "Tupas",
"Tunnistettu": "2025-11-05T11:40:20.1926513+02:00"
},
"Arkistoitu": "2025-11-05T11:40:20.1926513+02:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfApiOsapuoliPerustiedot xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Osapuolirekisteri">
<ApiOsapuoliPerustiedot>
<Arkistoitu>2025-11-05T11:40:20.1926513+02:00</Arkistoitu>
<Etunimi>sample string 3</Etunimi>
<Id>1</Id>
<Katuosoite>sample string 5</Katuosoite>
<Matkapuhelin>sample string 9</Matkapuhelin>
<Nimi>sample string 2</Nimi>
<Osapuolityyppi>Henkilo</Osapuolityyppi>
<Postinumero>sample string 6</Postinumero>
<Postitoimipaikka>sample string 7</Postitoimipaikka>
<Puhelin>sample string 8</Puhelin>
<Sahkoposti>sample string 10</Sahkoposti>
<Sukunimi>sample string 4</Sukunimi>
<Tunnistautuminen>
<Tunnistettu>2025-11-05T11:40:20.1926513+02:00</Tunnistettu>
<Tyyppi>Tupas</Tyyppi>
</Tunnistautuminen>
<Tunnus>sample string 11</Tunnus>
<Turvakielto>true</Turvakielto>
<YritysId>1</YritysId>
</ApiOsapuoliPerustiedot>
<ApiOsapuoliPerustiedot>
<Arkistoitu>2025-11-05T11:40:20.1926513+02:00</Arkistoitu>
<Etunimi>sample string 3</Etunimi>
<Id>1</Id>
<Katuosoite>sample string 5</Katuosoite>
<Matkapuhelin>sample string 9</Matkapuhelin>
<Nimi>sample string 2</Nimi>
<Osapuolityyppi>Henkilo</Osapuolityyppi>
<Postinumero>sample string 6</Postinumero>
<Postitoimipaikka>sample string 7</Postitoimipaikka>
<Puhelin>sample string 8</Puhelin>
<Sahkoposti>sample string 10</Sahkoposti>
<Sukunimi>sample string 4</Sukunimi>
<Tunnistautuminen>
<Tunnistettu>2025-11-05T11:40:20.1926513+02:00</Tunnistettu>
<Tyyppi>Tupas</Tyyppi>
</Tunnistautuminen>
<Tunnus>sample string 11</Tunnus>
<Turvakielto>true</Turvakielto>
<YritysId>1</YritysId>
</ApiOsapuoliPerustiedot>
</ArrayOfApiOsapuoliPerustiedot>