GET api/property/comparables?propertyId={propertyId}&latitude={latitude}&longitude={longitude}&mileRadius={mileRadius}&pageSize={pageSize}&pageNumber={pageNumber}&branchId={branchId}&isForLetting={isForLetting}
For a given property, will return all comparable property's nearby.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
propertyId |
The id of the property to find comparables for. Can be null if latitude and longitude set |
integer |
None. |
latitude |
The latitude to find comparables for. Can be null if property id set |
decimal number |
None. |
longitude |
The longitude to find comparables for. Can be null if property id set |
decimal number |
None. |
mileRadius |
how near to compare (default 1 mile) |
decimal number |
Default value is 1 |
pageSize | integer |
Default value is 20 |
|
pageNumber | integer |
Default value is 1 |
|
branchId |
Optional Branch Id |
integer |
None. |
isForLetting |
Indicate if the request is for Sales or Lettings |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Property.Query.Comparables.ComparablePropertyDataContractName | Description | Type | Additional information |
---|---|---|---|
TotalCount | integer |
None. |
|
CurrentCount | integer |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
Collection | Collection of Dezrez.Core.DataContracts.External.Api.Property.Query.Comparables.ComparablePropertyDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalCount": 1, "CurrentCount": 2, "PageSize": 1, "PageNumber": 1, "Collection": [ { "PropertyId": 1, "Address": { "Location": { "CenterPoint": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Extent": [ { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 } ], "ViewPoints": [ { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 }, { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 } ], "Id": 1 }, "AddressSource": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SourceId": "sample string 1", "OrganizationName": "sample string 2", "Number": "sample string 3", "BuildingName": "sample string 4", "Street": "sample string 5", "Town": "sample string 6", "Locality": "sample string 7", "County": "sample string 8", "Postcode": "sample string 9", "CreatedDate": "2024-10-06T03:29:52.6301078Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 11 }, "Bedrooms": 1, "MilesFromTargetProperty": 2.1, "DateValued": "2024-10-06T03:29:52.6301078Z", "MostRecentValuedPrice": 3.1, "MostRecentSoldPrice": 4.1, "DateSold": "2024-10-06T03:29:52.6301078Z", "DateValuedForLet": "2024-10-06T03:29:52.6301078Z", "MostRecentValuedPriceForLet": 5.1, "MostRecentValuedPriceTypeForLet": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "MostRecentLetPrice": 6.1, "MostRecentLetPriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DateLet": "2024-10-06T03:29:52.6301078Z", "LetTermType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } }, { "PropertyId": 1, "Address": { "Location": { "CenterPoint": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Extent": [ { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 } ], "ViewPoints": [ { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 }, { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 } ], "Id": 1 }, "AddressSource": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SourceId": "sample string 1", "OrganizationName": "sample string 2", "Number": "sample string 3", "BuildingName": "sample string 4", "Street": "sample string 5", "Town": "sample string 6", "Locality": "sample string 7", "County": "sample string 8", "Postcode": "sample string 9", "CreatedDate": "2024-10-06T03:29:52.6301078Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 11 }, "Bedrooms": 1, "MilesFromTargetProperty": 2.1, "DateValued": "2024-10-06T03:29:52.6301078Z", "MostRecentValuedPrice": 3.1, "MostRecentSoldPrice": 4.1, "DateSold": "2024-10-06T03:29:52.6301078Z", "DateValuedForLet": "2024-10-06T03:29:52.6301078Z", "MostRecentValuedPriceForLet": 5.1, "MostRecentValuedPriceTypeForLet": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "MostRecentLetPrice": 6.1, "MostRecentLetPriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DateLet": "2024-10-06T03:29:52.6301078Z", "LetTermType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } } ] }