POST 17.0/app/properties/list

Description

Gets a list of Properties

URI Parameters

None.

PropertyListFilters
Name Description Type Additional information
Usages

Collection of integer

None.
Statuses

Collection of integer

None.
Categories

Collection of integer

None.
Types

Collection of integer

None.
AgencyAgreementTypes

Collection of integer

None.
AssignedTo

Collection of integer

None.
Branches

Collection of integer

None.
Areas

Collection of integer

None.
SellingMethods

Collection of integer

None.
ManagementTypes

Collection of integer

None.
SocialStatuses

Collection of integer

None.
Furnished

Collection of integer

None.

application/json, text/json
Sample: 
{
  "usages": [
    1,
    2
  ],
  "statuses": [
    1,
    2
  ],
  "categories": [
    1,
    2
  ],
  "types": [
    1,
    2
  ],
  "agencyAgreementTypes": [
    1,
    2
  ],
  "assignedTo": [
    1,
    2
  ],
  "branches": [
    1,
    2
  ],
  "areas": [
    1,
    2
  ],
  "sellingMethods": [
    1,
    2
  ],
  "managementTypes": [
    1,
    2
  ],
  "socialStatuses": [
    1,
    2
  ],
  "furnished": [
    1,
    2
  ]
}

application/xml, text/xml
Sample: 
<PropertyListFilters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Usages>
    <int>1</int>
    <int>2</int>
  </Usages>
  <Statuses>
    <int>1</int>
    <int>2</int>
  </Statuses>
  <Categories>
    <int>1</int>
    <int>2</int>
  </Categories>
  <Types>
    <int>1</int>
    <int>2</int>
  </Types>
  <AgencyAgreementTypes>
    <int>1</int>
    <int>2</int>
  </AgencyAgreementTypes>
  <AssignedTo>
    <int>1</int>
    <int>2</int>
  </AssignedTo>
  <Branches>
    <int>1</int>
    <int>2</int>
  </Branches>
  <Areas>
    <int>1</int>
    <int>2</int>
  </Areas>
  <SellingMethods>
    <int>1</int>
    <int>2</int>
  </SellingMethods>
  <ManagementTypes>
    <int>1</int>
    <int>2</int>
  </ManagementTypes>
  <SocialStatuses>
    <int>1</int>
    <int>2</int>
  </SocialStatuses>
  <Furnished>
    <int>1</int>
    <int>2</int>
  </Furnished>
</PropertyListFilters>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of PropertyListItem
Name Description Type Additional information
ID

integer

None.
HasPictures

boolean

None.
Address

string

None.
Beds

integer

None.
Price

decimal number

None.
Type

IDDescriptionPair

None.
Category

IDDescriptionPair

None.
Status

IDDescriptionPair

None.
Commission

string

None.
Owner

PropertyListItemOwner

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "hasPictures": true,
    "address": "sample string 3",
    "beds": 4,
    "price": 5.0,
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "category": {
      "id": 1,
      "description": "sample string 2"
    },
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "commission": "sample string 6",
    "owner": {
      "id": 1,
      "description": "sample string 2",
      "email": "sample string 3",
      "mobile": "sample string 4",
      "marketingPreferences": {
        "post": true,
        "email": true,
        "smsText": true,
        "telephone": true,
        "passDetailsToThirdParties": true,
        "passDetailsToIFA": true,
        "passDetailsToConveyancer": true
      }
    }
  },
  {
    "id": 1,
    "hasPictures": true,
    "address": "sample string 3",
    "beds": 4,
    "price": 5.0,
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "category": {
      "id": 1,
      "description": "sample string 2"
    },
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "commission": "sample string 6",
    "owner": {
      "id": 1,
      "description": "sample string 2",
      "email": "sample string 3",
      "mobile": "sample string 4",
      "marketingPreferences": {
        "post": true,
        "email": true,
        "smsText": true,
        "telephone": true,
        "passDetailsToThirdParties": true,
        "passDetailsToIFA": true,
        "passDetailsToConveyancer": true
      }
    }
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPropertyListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PropertyListItem>
    <ID>1</ID>
    <HasPictures>true</HasPictures>
    <Address>sample string 3</Address>
    <Beds>4</Beds>
    <Price>5</Price>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <Category>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Category>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Commission>sample string 6</Commission>
    <Owner>
      <ID>1</ID>
      <Description>sample string 2</Description>
      <Email>sample string 3</Email>
      <Mobile>sample string 4</Mobile>
      <MarketingPreferences>
        <Post>true</Post>
        <Email>true</Email>
        <SmsText>true</SmsText>
        <Telephone>true</Telephone>
        <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
        <PassDetailsToIFA>true</PassDetailsToIFA>
        <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
      </MarketingPreferences>
    </Owner>
  </PropertyListItem>
  <PropertyListItem>
    <ID>1</ID>
    <HasPictures>true</HasPictures>
    <Address>sample string 3</Address>
    <Beds>4</Beds>
    <Price>5</Price>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <Category>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Category>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Commission>sample string 6</Commission>
    <Owner>
      <ID>1</ID>
      <Description>sample string 2</Description>
      <Email>sample string 3</Email>
      <Mobile>sample string 4</Mobile>
      <MarketingPreferences>
        <Post>true</Post>
        <Email>true</Email>
        <SmsText>true</SmsText>
        <Telephone>true</Telephone>
        <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
        <PassDetailsToIFA>true</PassDetailsToIFA>
        <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
      </MarketingPreferences>
    </Owner>
  </PropertyListItem>
</ArrayOfPropertyListItem>