POST api/unit/Search

Request Information

URI Parameters

None.

Body Parameters

UnitSearchParams
NameDescriptionTypeAdditional information
City

string

None.

Zip

string

None.

MinBedroomCount

integer

None.

MaxBedroomCount

integer

None.

MinBathroomCount

integer

None.

MaxBathroomCount

integer

None.

MinRentPrice

decimal number

None.

MaxRentPrice

decimal number

None.

BuildingAmenityIDs

Collection of integer

None.

BuildingAccessibilityIDs

Collection of integer

None.

UnitAmenityIDs

Collection of integer

None.

UnitAccessibilityIDs

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "City": "sample string 1",
  "Zip": "sample string 2",
  "MinBedroomCount": 1,
  "MaxBedroomCount": 1,
  "MinBathroomCount": 1,
  "MaxBathroomCount": 1,
  "MinRentPrice": 1.1,
  "MaxRentPrice": 1.1,
  "BuildingAmenityIDs": [
    1,
    2
  ],
  "BuildingAccessibilityIDs": [
    1,
    2
  ],
  "UnitAmenityIDs": [
    1,
    2
  ],
  "UnitAccessibilityIDs": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<UnitSearchParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WisspNetApi.Models">
  <BuildingAccessibilityIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BuildingAccessibilityIDs>
  <BuildingAmenityIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BuildingAmenityIDs>
  <City>sample string 1</City>
  <MaxBathroomCount>1</MaxBathroomCount>
  <MaxBedroomCount>1</MaxBedroomCount>
  <MaxRentPrice>1.1</MaxRentPrice>
  <MinBathroomCount>1</MinBathroomCount>
  <MinBedroomCount>1</MinBedroomCount>
  <MinRentPrice>1.1</MinRentPrice>
  <UnitAccessibilityIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </UnitAccessibilityIDs>
  <UnitAmenityIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </UnitAmenityIDs>
  <Zip>sample string 2</Zip>
</UnitSearchParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UnitSearchParams'.

Response Information

Resource Description

Collection of UnitSearchParams
NameDescriptionTypeAdditional information
City

string

None.

Zip

string

None.

MinBedroomCount

integer

None.

MaxBedroomCount

integer

None.

MinBathroomCount

integer

None.

MaxBathroomCount

integer

None.

MinRentPrice

decimal number

None.

MaxRentPrice

decimal number

None.

BuildingAmenityIDs

Collection of integer

None.

BuildingAccessibilityIDs

Collection of integer

None.

UnitAmenityIDs

Collection of integer

None.

UnitAccessibilityIDs

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "City": "sample string 1",
    "Zip": "sample string 2",
    "MinBedroomCount": 1,
    "MaxBedroomCount": 1,
    "MinBathroomCount": 1,
    "MaxBathroomCount": 1,
    "MinRentPrice": 1.1,
    "MaxRentPrice": 1.1,
    "BuildingAmenityIDs": [
      1,
      2
    ],
    "BuildingAccessibilityIDs": [
      1,
      2
    ],
    "UnitAmenityIDs": [
      1,
      2
    ],
    "UnitAccessibilityIDs": [
      1,
      2
    ]
  },
  {
    "City": "sample string 1",
    "Zip": "sample string 2",
    "MinBedroomCount": 1,
    "MaxBedroomCount": 1,
    "MinBathroomCount": 1,
    "MaxBathroomCount": 1,
    "MinRentPrice": 1.1,
    "MaxRentPrice": 1.1,
    "BuildingAmenityIDs": [
      1,
      2
    ],
    "BuildingAccessibilityIDs": [
      1,
      2
    ],
    "UnitAmenityIDs": [
      1,
      2
    ],
    "UnitAccessibilityIDs": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfUnitSearchParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WisspNetApi.Models">
  <UnitSearchParams>
    <BuildingAccessibilityIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </BuildingAccessibilityIDs>
    <BuildingAmenityIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </BuildingAmenityIDs>
    <City>sample string 1</City>
    <MaxBathroomCount>1</MaxBathroomCount>
    <MaxBedroomCount>1</MaxBedroomCount>
    <MaxRentPrice>1.1</MaxRentPrice>
    <MinBathroomCount>1</MinBathroomCount>
    <MinBedroomCount>1</MinBedroomCount>
    <MinRentPrice>1.1</MinRentPrice>
    <UnitAccessibilityIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </UnitAccessibilityIDs>
    <UnitAmenityIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </UnitAmenityIDs>
    <Zip>sample string 2</Zip>
  </UnitSearchParams>
  <UnitSearchParams>
    <BuildingAccessibilityIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </BuildingAccessibilityIDs>
    <BuildingAmenityIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </BuildingAmenityIDs>
    <City>sample string 1</City>
    <MaxBathroomCount>1</MaxBathroomCount>
    <MaxBedroomCount>1</MaxBedroomCount>
    <MaxRentPrice>1.1</MaxRentPrice>
    <MinBathroomCount>1</MinBathroomCount>
    <MinBedroomCount>1</MinBedroomCount>
    <MinRentPrice>1.1</MinRentPrice>
    <UnitAccessibilityIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </UnitAccessibilityIDs>
    <UnitAmenityIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </UnitAmenityIDs>
    <Zip>sample string 2</Zip>
  </UnitSearchParams>
</ArrayOfUnitSearchParams>