GET api/RentalPropertySearch

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RequiresHousingBenefit

boolean

None.

IsStudent

boolean

None.

IsSmoker

boolean

None.

HasPets

boolean

None.

HasChildren

boolean

None.

FurnishRequirement

FurnishRequirement

None.

ReceptionsFrom

integer

None.

ReceptionsTo

integer

None.

HasGarden

boolean

None.

IsRetirementProperty

boolean

None.

CentralHeatingType

integer

None.

ExcludeExtendedSearchFilters

boolean

None.

BedroomsFrom

integer

None.

BedroomsTo

integer

None.

SearchId

integer

None.

Area

Collection of Coordinates

None.

LocationName

string

None.

DrawnSearchData

globally unique identifier

None.

Latitude

decimal number

None.

Longitude

decimal number

None.

Radius

decimal number

None.

PriceFrom

integer

None.

PriceTo

integer

None.

ParkingTypes

Collection of integer

None.

PropertySort

PropertySort

None.

PropertyTypes

Collection of integer

None.

OnlineSearch

boolean

None.

PutOnMarketSince

date

None.

PartnerAgentId

integer

None.

Page

integer

None.

PageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

SearchResultDataOfRentalPropertySearchModel
NameDescriptionTypeAdditional information
Results

Collection of PropertySearchResult

None.

SearchModel

RentalPropertySearchModel

None.

UpdatedRadius

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Results": {
    "Items": [],
    "Count": 0,
    "PageCount": 1,
    "TotalItemCount": 2,
    "PageNumber": 3,
    "PageSize": 4,
    "HasPreviousPage": true,
    "HasNextPage": true,
    "IsFirstPage": true,
    "IsLastPage": true,
    "FirstItemOnPage": 9,
    "LastItemOnPage": 10
  },
  "SearchModel": {
    "RequiresHousingBenefit": true,
    "IsStudent": true,
    "IsSmoker": true,
    "HasPets": true,
    "HasChildren": true,
    "FurnishRequirement": 0,
    "ReceptionsFrom": 1,
    "ReceptionsTo": 1,
    "HasGarden": true,
    "IsRetirementProperty": true,
    "CentralHeatingType": 1,
    "ExcludeExtendedSearchFilters": true,
    "BedroomsFrom": 1,
    "BedroomsTo": 1,
    "SearchId": 1,
    "Area": [
      {
        "Latitude": 1.0,
        "Longitude": 2.0
      },
      {
        "Latitude": 1.0,
        "Longitude": 2.0
      }
    ],
    "LocationName": "sample string 3",
    "DrawnSearchData": "88c8142c-3a5a-4b48-92cb-a076024053ed",
    "Latitude": 1.0,
    "Longitude": 1.0,
    "Radius": 1.0,
    "PriceFrom": 1,
    "PriceTo": 1,
    "ParkingTypes": [
      1,
      2
    ],
    "PropertySort": 1,
    "PropertyTypes": [
      1,
      2
    ],
    "OnlineSearch": true,
    "PutOnMarketSince": "2017-07-21T09:02:32.581977+01:00",
    "PartnerAgentId": 1,
    "Page": 5,
    "PageSize": 6
  },
  "UpdatedRadius": 1
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.