POST api/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
City	string	None.
Zip	string	None.
OrderOfUnits	string	None.
NumberOfDays	integer	None.
State	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",
  "OrderOfUnits": "sample string 3",
  "NumberOfDays": 1,
  "State": "sample string 4",
  "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>
  <NumberOfDays>1</NumberOfDays>
  <OrderOfUnits>sample string 3</OrderOfUnits>
  <State>sample string 4</State>
  <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

SearchResponse

Name	Type	Additional information
SearchID	integer	None.
Buildings	Collection of BuildingSearchData	None.
Units	Collection of Unit	None.
MaxPage	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "SearchID": 1,
  "Buildings": [
    {
      "BuildingID": 1,
      "Longitude": 1.0,
      "Latitude": 1.0,
      "UnitIDs": [
        1,
        2
      ],
      "Address": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Name": "sample string 5",
      "MinRentPrice": 6.0,
      "MaxRentPrice": 7.0,
      "StreetPOV": {
        "Heading": 1.0,
        "Pitch": 2.0,
        "Zoom": 3.0
      },
      "PhotoURL": "sample string 8",
      "Amenities": [
        "sample string 1",
        "sample string 2"
      ],
      "Accessibilities": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "BuildingID": 1,
      "Longitude": 1.0,
      "Latitude": 1.0,
      "UnitIDs": [
        1,
        2
      ],
      "Address": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Name": "sample string 5",
      "MinRentPrice": 6.0,
      "MaxRentPrice": 7.0,
      "StreetPOV": {
        "Heading": 1.0,
        "Pitch": 2.0,
        "Zoom": 3.0
      },
      "PhotoURL": "sample string 8",
      "Amenities": [
        "sample string 1",
        "sample string 2"
      ],
      "Accessibilities": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "Units": null,
  "MaxPage": 1
}

application/xml, text/xml

Sample:

<SearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WisspNetApi.Models">
  <Buildings>
    <BuildingSearchData>
      <Accessibilities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Accessibilities>
      <Address>sample string 2</Address>
      <Amenities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Amenities>
      <BuildingID>1</BuildingID>
      <City>sample string 3</City>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <MaxRentPrice>7</MaxRentPrice>
      <MinRentPrice>6</MinRentPrice>
      <Name>sample string 5</Name>
      <PhotoURL>sample string 8</PhotoURL>
      <State>sample string 4</State>
      <StreetPOV>
        <Heading>1</Heading>
        <Pitch>2</Pitch>
        <Zoom>3</Zoom>
      </StreetPOV>
      <UnitIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </UnitIDs>
    </BuildingSearchData>
    <BuildingSearchData>
      <Accessibilities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Accessibilities>
      <Address>sample string 2</Address>
      <Amenities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Amenities>
      <BuildingID>1</BuildingID>
      <City>sample string 3</City>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <MaxRentPrice>7</MaxRentPrice>
      <MinRentPrice>6</MinRentPrice>
      <Name>sample string 5</Name>
      <PhotoURL>sample string 8</PhotoURL>
      <State>sample string 4</State>
      <StreetPOV>
        <Heading>1</Heading>
        <Pitch>2</Pitch>
        <Zoom>3</Zoom>
      </StreetPOV>
      <UnitIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </UnitIDs>
    </BuildingSearchData>
  </Buildings>
  <MaxPage>1</MaxPage>
  <SearchID>1</SearchID>
  <Units i:nil="true" />
</SearchResponse>