POST api/CompetitorProperty

Adds a property if its unique ID has not been indexed before, otherwise updates the existing entry.

Request Information

URI Parameters

None.

Body Parameters

From third-party data

Name	Description	Type	Additional information
Bedrooms	Number of bedrooms; can be zero for studio flats, Land or Other.	integer	None.
Brand	Brand associated with the property, e.g. haart.	string	Required
CompanyName	Managing company.	string	Required
County	Address county.	string	None.
Id	The database ID.	integer	None.
IsPurchase	True: for sale, false: for rent.	boolean	Required
Latitude	Latitude position.	decimal number	None.
Longitude	Longitude position.	decimal number	None.
OfficeId	The branch managing the property.	string	Required
PostCode	Address postcode.	string	None.
PropertyType	ID of the property type, e.g. bungalow.	integer	None.
RightMoveUrl	Absolute URL to the Right Move details page.	string	None.
SellingPrice	The selling price if this property is for sale.	decimal number	None.
ShortAddress	Address shown in the details of a property. Often includes the road name but not e.g. the house number/name.	string	None.
SoldDate	If set, the date on which this property was sold.	date	None.
Town	Address town.	string	None.
UniqueId	Unique ID, used as a PIN for sellers to add their properties in the my haart account section.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "RightMoveUrl": "sample string 2",
  "Bedrooms": 1,
  "Brand": "sample string 3",
  "County": "sample string 4",
  "Id": 5,
  "IsPurchase": true,
  "Latitude": 1.1,
  "Longitude": 1.1,
  "OfficeId": "sample string 7",
  "PostCode": "sample string 8",
  "PropertyType": 9,
  "SellingPrice": 1.0,
  "ShortAddress": "sample string 10",
  "SoldDate": "2024-08-30T00:15:21.1884497+00:00",
  "Town": "sample string 11",
  "UniqueId": "sample string 12"
}

application/xml, text/xml

Sample:

<CompetitorPropertyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Spicerhaart.PropertyIndexer.Models">
  <Bedrooms>1</Bedrooms>
  <Brand>sample string 3</Brand>
  <County>sample string 4</County>
  <Id>5</Id>
  <IsPurchase>true</IsPurchase>
  <Latitude>1.1</Latitude>
  <Longitude>1.1</Longitude>
  <OfficeId>sample string 7</OfficeId>
  <PostCode>sample string 8</PostCode>
  <PropertyType>9</PropertyType>
  <SellingPrice>1</SellingPrice>
  <ShortAddress>sample string 10</ShortAddress>
  <SoldDate>2024-08-30T00:15:21.1884497+00:00</SoldDate>
  <Town>sample string 11</Town>
  <UniqueId>sample string 12</UniqueId>
  <CompanyName>sample string 1</CompanyName>
  <RightMoveUrl>sample string 2</RightMoveUrl>
</CompetitorPropertyResult>

Response Information

Resource Description

Success

HttpResponseMessage

Name	Type	Additional information
Content	HttpContent	None.
Headers	Collection of Object	None.
IsSuccessStatusCode	boolean	None.
ReasonPhrase	string	None.
RequestMessage	HttpRequestMessage	None.
StatusCode	HttpStatusCode	None.
Version	Version	None.