GET api/BuyPropertySearch

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeUnderOffer

boolean

None.

IncludeAuctions

boolean

None.

HasLand

boolean

None.

RequiresWork

boolean

None.

RequiresUpdating

boolean

None.

NewBuild

boolean

None.

Tenure

PropertyTenure

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

SearchResultDataOfBuyingPropertySearchModel
NameDescriptionTypeAdditional information
Results

Collection of PropertySearchResult

None.

SearchModel

BuyingPropertySearchModel

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": {
    "IncludeUnderOffer": true,
    "IncludeAuctions": true,
    "HasLand": true,
    "RequiresWork": true,
    "RequiresUpdating": true,
    "NewBuild": true,
    "Tenure": 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 4",
    "DrawnSearchData": "050b8162-40f4-4fe5-9802-be9246bb3177",
    "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:31:19.9567453+01:00",
    "PartnerAgentId": 1,
    "Page": 6,
    "PageSize": 7
  },
  "UpdatedRadius": 1
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.