POST 17.0/find/property

Description

Finds property records based on the passed query

URI Parameters

None.

PropertyFindQuery
Name Description Type Additional information
Filters

PropertyFindFilters

None.
TextToFind

string

Required
MaxResults

integer

None.

application/json, text/json
Sample: 
{
  "filters": {
    "branchID": 1,
    "category": 2,
    "status": 3
  },
  "textToFind": "sample string 1",
  "maxResults": 2
}

application/xml, text/xml
Sample: 
<PropertyFindQuery xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TextToFind>sample string 1</TextToFind>
  <MaxResults>2</MaxResults>
  <Filters>
    <BranchID>1</BranchID>
    <Category>2</Category>
    <Status>3</Status>
  </Filters>
</PropertyFindQuery>

application/x-www-form-urlencoded
Sample:

Sample not available.

A list of properties that match the passed query

Collection of PropertyFindResult
Name Description Type Additional information
ID

integer

None.
HasPictures

boolean

None.
Address

string

None.
Category

IDDescriptionPair

None.
Status

IDDescriptionPair

None.
Price

string

None.
AltReference

string

None.
Owner

string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "hasPictures": true,
    "address": "sample string 3",
    "category": {
      "id": 1,
      "description": "sample string 2"
    },
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "price": "sample string 4",
    "altReference": "sample string 5",
    "owner": "sample string 6"
  },
  {
    "id": 1,
    "hasPictures": true,
    "address": "sample string 3",
    "category": {
      "id": 1,
      "description": "sample string 2"
    },
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "price": "sample string 4",
    "altReference": "sample string 5",
    "owner": "sample string 6"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPropertyFindResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PropertyFindResult>
    <ID>1</ID>
    <HasPictures>true</HasPictures>
    <Address>sample string 3</Address>
    <Category>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Category>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Price>sample string 4</Price>
    <AltReference>sample string 5</AltReference>
    <Owner>sample string 6</Owner>
  </PropertyFindResult>
  <PropertyFindResult>
    <ID>1</ID>
    <HasPictures>true</HasPictures>
    <Address>sample string 3</Address>
    <Category>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Category>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Price>sample string 4</Price>
    <AltReference>sample string 5</AltReference>
    <Owner>sample string 6</Owner>
  </PropertyFindResult>
</ArrayOfPropertyFindResult>