POST yhteydet/asukkaat/hae

Hakee asukasyhteyksiä valinnaisella kohdeIdllä ja hakutermillä. Jos kohdeIdtä ei anneta, haetaan kaikista omien kustannuspaikkojen asukkaista. Hakusanalla voi hakea asukkaita nimen, sähköpostin, matkapuhelinnumeron tai puhelinnumeron mukaan.

Request Information

URI Parameters

None.

Body Parameters

ApiAsukasYhteysSearchRequest
NameDescriptionTypeAdditional information
Hakusana Hakusana, joka saa sisältää maksimissaan kolme termiä, esimerkiksi nimeä. Hakusanalla voi hakea asukkaita nimen, sähköpostin, matkapuhelinnumeron tai puhelinnumeron mukaan. string String length: inclusive between 3 and 50
KohdeId Haetaan kohteen tai sen alla olevien kohteiden asukkaita. integer None.
Take Suodatetaan asukkaiden hakutulosten enimmäismäärä. Palauttaa maksimissaan 50 hakutulosta. integer None.
Sort Järjestelee hakutuloksen annetun parametrin mukaisesti, esimerkiksi osapuolen nimen mukaisesti. ApiAsukasSort None.
Order Määrittelee hakutuloksen järjestyksen nousevasti tai laskevasti. ApiSortOrder None.

Request Formats

application/json, text/json
Sample: 
{
  "Hakusana": "sample string 1",
  "KohdeId": 1,
  "Take": 1,
  "Sort": "Name",
  "Order": "asc"
}
application/xml, text/xml
Sample: 
<ApiAsukasYhteysSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Yhteydet">
  <Hakusana>sample string 1</Hakusana>
  <KohdeId>1</KohdeId>
  <Order>asc</Order>
  <Sort>Name</Sort>
  <Take>1</Take>
</ApiAsukasYhteysSearchRequest>
application/x-www-form-urlencoded
Sample:

Sample not available.

Response Information

Resource Description


Collection of ApiAsukasResponse
NameDescriptionTypeAdditional information
Id Id integer None.
Nimi Nimi string None.
Sukunimi Sukunimi string None.
Puhelin Puhelinnumero string None.
Matkapuhelin Matkapuhelimen numero string None.
Sahkoposti Sähköposti string None.
SyntymaAika Syntymäaika date None.
YhteysId YhteysId integer None.
SopimusOsapuoli Sopimusosapuoli boolean None.
Turvakielto Turvakiellossa olevia tietoja ei saa näyttää julkisesti boolean None.
Huoneisto Huoneiston tiedot ApiHuoneisto None.
SisaanmuuttoPvm Sisäänmuuttoajankohta date None.
UlosmuuttoPvm Ulosmuuttoajankohta date None.

Response Formats

application/json, text/json
Sample: 
[
  {
    "Id": 1,
    "Nimi": "sample string 2",
    "Sukunimi": "sample string 3",
    "Puhelin": "sample string 4",
    "Matkapuhelin": "sample string 5",
    "Sahkoposti": "sample string 6",
    "SyntymaAika": "2024-05-06T13:16:16.8661205+03:00",
    "YhteysId": 7,
    "SopimusOsapuoli": true,
    "Turvakielto": true,
    "Huoneisto": {
      "Id": 1,
      "Tunnus": "sample string 2",
      "Nimi": "sample string 3",
      "Tyyppi": "sample string 4",
      "Katuosoite": "sample string 5",
      "Rappu": "sample string 6",
      "Kerros": "sample string 7",
      "Neliot": 1.1,
      "JyvitetytNeliot": 1.1
    },
    "SisaanmuuttoPvm": "2024-05-06T13:16:16.8661205+03:00",
    "UlosmuuttoPvm": "2024-05-06T13:16:16.8661205+03:00"
  },
  {
    "Id": 1,
    "Nimi": "sample string 2",
    "Sukunimi": "sample string 3",
    "Puhelin": "sample string 4",
    "Matkapuhelin": "sample string 5",
    "Sahkoposti": "sample string 6",
    "SyntymaAika": "2024-05-06T13:16:16.8661205+03:00",
    "YhteysId": 7,
    "SopimusOsapuoli": true,
    "Turvakielto": true,
    "Huoneisto": {
      "Id": 1,
      "Tunnus": "sample string 2",
      "Nimi": "sample string 3",
      "Tyyppi": "sample string 4",
      "Katuosoite": "sample string 5",
      "Rappu": "sample string 6",
      "Kerros": "sample string 7",
      "Neliot": 1.1,
      "JyvitetytNeliot": 1.1
    },
    "SisaanmuuttoPvm": "2024-05-06T13:16:16.8661205+03:00",
    "UlosmuuttoPvm": "2024-05-06T13:16:16.8661205+03:00"
  }
]
application/xml, text/xml
Sample: 
<ArrayOfApiAsukasResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Osapuolirekisteri">
  <ApiAsukasResponse>
    <Huoneisto xmlns:d3p1="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Kohderekisteri">
      <d3p1:Id>1</d3p1:Id>
      <d3p1:JyvitetytNeliot>1.1</d3p1:JyvitetytNeliot>
      <d3p1:Katuosoite>sample string 5</d3p1:Katuosoite>
      <d3p1:Kerros>sample string 7</d3p1:Kerros>
      <d3p1:Neliot>1.1</d3p1:Neliot>
      <d3p1:Nimi>sample string 3</d3p1:Nimi>
      <d3p1:Rappu>sample string 6</d3p1:Rappu>
      <d3p1:Tunnus>sample string 2</d3p1:Tunnus>
      <d3p1:Tyyppi>sample string 4</d3p1:Tyyppi>
    </Huoneisto>
    <Id>1</Id>
    <Matkapuhelin>sample string 5</Matkapuhelin>
    <Nimi>sample string 2</Nimi>
    <Puhelin>sample string 4</Puhelin>
    <Sahkoposti>sample string 6</Sahkoposti>
    <SisaanmuuttoPvm>2024-05-06T13:16:16.8661205+03:00</SisaanmuuttoPvm>
    <SopimusOsapuoli>true</SopimusOsapuoli>
    <Sukunimi>sample string 3</Sukunimi>
    <SyntymaAika>2024-05-06T13:16:16.8661205+03:00</SyntymaAika>
    <Turvakielto>true</Turvakielto>
    <UlosmuuttoPvm>2024-05-06T13:16:16.8661205+03:00</UlosmuuttoPvm>
    <YhteysId>7</YhteysId>
  </ApiAsukasResponse>
  <ApiAsukasResponse>
    <Huoneisto xmlns:d3p1="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Kohderekisteri">
      <d3p1:Id>1</d3p1:Id>
      <d3p1:JyvitetytNeliot>1.1</d3p1:JyvitetytNeliot>
      <d3p1:Katuosoite>sample string 5</d3p1:Katuosoite>
      <d3p1:Kerros>sample string 7</d3p1:Kerros>
      <d3p1:Neliot>1.1</d3p1:Neliot>
      <d3p1:Nimi>sample string 3</d3p1:Nimi>
      <d3p1:Rappu>sample string 6</d3p1:Rappu>
      <d3p1:Tunnus>sample string 2</d3p1:Tunnus>
      <d3p1:Tyyppi>sample string 4</d3p1:Tyyppi>
    </Huoneisto>
    <Id>1</Id>
    <Matkapuhelin>sample string 5</Matkapuhelin>
    <Nimi>sample string 2</Nimi>
    <Puhelin>sample string 4</Puhelin>
    <Sahkoposti>sample string 6</Sahkoposti>
    <SisaanmuuttoPvm>2024-05-06T13:16:16.8661205+03:00</SisaanmuuttoPvm>
    <SopimusOsapuoli>true</SopimusOsapuoli>
    <Sukunimi>sample string 3</Sukunimi>
    <SyntymaAika>2024-05-06T13:16:16.8661205+03:00</SyntymaAika>
    <Turvakielto>true</Turvakielto>
    <UlosmuuttoPvm>2024-05-06T13:16:16.8661205+03:00</UlosmuuttoPvm>
    <YhteysId>7</YhteysId>
  </ApiAsukasResponse>
</ArrayOfApiAsukasResponse>