GET osapuolet/yritykset?Hakusana={Hakusana}&Metanimi={Metanimi}&Tasmalleen={Tasmalleen}

Palauttaa kokoelman yritysosapuolia, joiden määrätty parametri vastaa annettuun hakusanaan. Henkilöillä on "Parametrit"-kokoelma, mutta kokoelma on aina tyhjä.

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 ApiOsapuoliResponse

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	ApiOsapuoliTyyppiInt	None.
Tunnistautuminen	Osapuolen tunnistautuminen	ApiOsapuoliTunnistautuminenResponse	None.
Parametrit	Osapuolen parametrit	Collection of ApiOsapuoliParametri	None.
Arkistoitu	Aikaleima osapuolen arkistointihetkestä	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "YritysId": 1,
    "Nimi": "sample string 2",
    "Turvakielto": true,
    "Osapuolityyppi": 0,
    "Tunnistautuminen": {
      "Tyyppi": "Tupas",
      "Tunnistettu": "2024-04-19T07:02:58.4100353+03:00"
    },
    "Parametrit": [
      {
        "KentanNimi": "sample string 1",
        "KentanMetaNimi": "sample string 2",
        "Arvo": "sample string 3"
      },
      {
        "KentanNimi": "sample string 1",
        "KentanMetaNimi": "sample string 2",
        "Arvo": "sample string 3"
      }
    ],
    "Arkistoitu": "2024-04-19T07:02:58.4100353+03:00"
  },
  {
    "Id": 1,
    "YritysId": 1,
    "Nimi": "sample string 2",
    "Turvakielto": true,
    "Osapuolityyppi": 0,
    "Tunnistautuminen": {
      "Tyyppi": "Tupas",
      "Tunnistettu": "2024-04-19T07:02:58.4100353+03:00"
    },
    "Parametrit": [
      {
        "KentanNimi": "sample string 1",
        "KentanMetaNimi": "sample string 2",
        "Arvo": "sample string 3"
      },
      {
        "KentanNimi": "sample string 1",
        "KentanMetaNimi": "sample string 2",
        "Arvo": "sample string 3"
      }
    ],
    "Arkistoitu": "2024-04-19T07:02:58.4100353+03:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiOsapuoliResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Osapuolirekisteri">
  <ApiOsapuoliResponse>
    <Arkistoitu>2024-04-19T07:02:58.4100353+03:00</Arkistoitu>
    <Id>1</Id>
    <Nimi>sample string 2</Nimi>
    <Osapuolityyppi>Henkilo</Osapuolityyppi>
    <Parametrit>
      <ApiOsapuoliParametri>
        <Arvo>sample string 3</Arvo>
        <KentanMetaNimi>sample string 2</KentanMetaNimi>
        <KentanNimi>sample string 1</KentanNimi>
      </ApiOsapuoliParametri>
      <ApiOsapuoliParametri>
        <Arvo>sample string 3</Arvo>
        <KentanMetaNimi>sample string 2</KentanMetaNimi>
        <KentanNimi>sample string 1</KentanNimi>
      </ApiOsapuoliParametri>
    </Parametrit>
    <Tunnistautuminen>
      <Tunnistettu>2024-04-19T07:02:58.4100353+03:00</Tunnistettu>
      <Tyyppi>Tupas</Tyyppi>
    </Tunnistautuminen>
    <Turvakielto>true</Turvakielto>
    <YritysId>1</YritysId>
  </ApiOsapuoliResponse>
  <ApiOsapuoliResponse>
    <Arkistoitu>2024-04-19T07:02:58.4100353+03:00</Arkistoitu>
    <Id>1</Id>
    <Nimi>sample string 2</Nimi>
    <Osapuolityyppi>Henkilo</Osapuolityyppi>
    <Parametrit>
      <ApiOsapuoliParametri>
        <Arvo>sample string 3</Arvo>
        <KentanMetaNimi>sample string 2</KentanMetaNimi>
        <KentanNimi>sample string 1</KentanNimi>
      </ApiOsapuoliParametri>
      <ApiOsapuoliParametri>
        <Arvo>sample string 3</Arvo>
        <KentanMetaNimi>sample string 2</KentanMetaNimi>
        <KentanNimi>sample string 1</KentanNimi>
      </ApiOsapuoliParametri>
    </Parametrit>
    <Tunnistautuminen>
      <Tunnistettu>2024-04-19T07:02:58.4100353+03:00</Tunnistettu>
      <Tyyppi>Tupas</Tyyppi>
    </Tunnistautuminen>
    <Turvakielto>true</Turvakielto>
    <YritysId>1</YritysId>
  </ApiOsapuoliResponse>
</ArrayOfApiOsapuoliResponse>