search

dezrez / DezrezCoreAPI

Resources relating to the Dezrez Core API
7 stars 3 forks source link

"Under Offer" properties #48

Closed simmerz closed 7 years ago

simmerz commented 7 years ago

Hi, trying to understand the Swagger UI docs, and failing. How would I go about getting a list of properties currently under offer/sale agreed?

rjmacarthy commented 7 years ago

Hi @simmerz the best way to do this would be using the property list endpoint, for example:

POST

api/list/property?pageSize=25&pageNumber=1

Using the following payload:

{
  "RoleStatuses": [
    "OfferAccepted"
  ],
  "RoleTypes": [
    "Selling"
  ],
  "Sort": "Price",
  "Order": "Descending",
  "Name": "InstructedProperties",
  "BranchId": 1
}

The role statuses array will allow you to filter properties in different statuses.

Hope that helps.