GET 1.0/website/properties/featured?branchid={branchid}&count={count}&mode={mode}&category={category}&completed={completed}&exclusive={exclusive}&picturecount={picturecount}

Description

Gets a list of featured properties for an agent

URI Parameters
Name Description Type Additional information
branchId

id of the branch for the agent

 integer

Default value is -1
count

Number of featured properties to retrieve

 integer

Default value is 5
mode

Used to specify which featured properties to retrieve (0: Mix of featured and non-featured properties, 1: Most recently added properties, 2: featured properties only)

 byte

Default value is 0
category

Category of properties to retrieve (0: sales, 1: lettings)

 integer

Default value is -1
completed

If set to true, only sold/let properties are retrieved

 boolean

Default value is False
exclusive

If set to true, only properties the agent has marked as exclusive will be retrieved

 boolean

Default value is False
pictureCount

Number of pictures to return per property

 integer

Default value is 5

None.

None.

Collection of PropertySearchResult
Name Description Type Additional information
ID

integer

Required
SitePrefix

string

None.
BranchID

integer

None.
AddedDate

string

None.
UpdatedDate

string

None.
Category

byte

None.
MarketDate

string

None.
Status

IDDescriptionPair

None.
Type

IDDescriptionPair

None.
Tenure

IDDescriptionPair

None.
Price

integer

None.
DisplayPrice

string

None.
Address

Address

None.
DisplayAddress

string

None.
Description

string

None.
Bedrooms

integer

None.
Bathrooms

integer

None.
Receptions

integer

None.
FloorArea

decimal number

None.
LandArea

decimal number

None.
RentalFurnished

string

None.
RentalAvailableDate

string

None.
Pictures

Collection of string

None.
VirtualTours

Collection of string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "sitePrefix": "sample string 2",
    "branchID": 3,
    "addedDate": "sample string 4",
    "updatedDate": "sample string 5",
    "category": 64,
    "marketDate": "sample string 7",
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "tenure": {
      "id": 1,
      "description": "sample string 2"
    },
    "price": 8,
    "displayPrice": "sample string 9",
    "address": {
      "country": "sample string 1",
      "countryCode": 2,
      "houseNumber": "sample string 3",
      "streetName": "sample string 4",
      "latitude": 5.0,
      "longitude": 6.0,
      "what3Words": "sample string 7",
      "propertyName": "sample string 8",
      "street": "sample string 9",
      "locality": "sample string 10",
      "town": "sample string 11",
      "region": "sample string 12",
      "postcode": "sample string 13"
    },
    "displayAddress": "sample string 10",
    "description": "sample string 11",
    "bedrooms": 12,
    "bathrooms": 13,
    "receptions": 14,
    "floorArea": 15.0,
    "landArea": 16.0,
    "rentalFurnished": "sample string 17",
    "rentalAvailableDate": "sample string 18",
    "pictures": [
      "sample string 1",
      "sample string 2"
    ],
    "virtualTours": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "id": 1,
    "sitePrefix": "sample string 2",
    "branchID": 3,
    "addedDate": "sample string 4",
    "updatedDate": "sample string 5",
    "category": 64,
    "marketDate": "sample string 7",
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "tenure": {
      "id": 1,
      "description": "sample string 2"
    },
    "price": 8,
    "displayPrice": "sample string 9",
    "address": {
      "country": "sample string 1",
      "countryCode": 2,
      "houseNumber": "sample string 3",
      "streetName": "sample string 4",
      "latitude": 5.0,
      "longitude": 6.0,
      "what3Words": "sample string 7",
      "propertyName": "sample string 8",
      "street": "sample string 9",
      "locality": "sample string 10",
      "town": "sample string 11",
      "region": "sample string 12",
      "postcode": "sample string 13"
    },
    "displayAddress": "sample string 10",
    "description": "sample string 11",
    "bedrooms": 12,
    "bathrooms": 13,
    "receptions": 14,
    "floorArea": 15.0,
    "landArea": 16.0,
    "rentalFurnished": "sample string 17",
    "rentalAvailableDate": "sample string 18",
    "pictures": [
      "sample string 1",
      "sample string 2"
    ],
    "virtualTours": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPropertySearchResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PropertySearchResult>
    <ID>1</ID>
    <SitePrefix>sample string 2</SitePrefix>
    <BranchID>3</BranchID>
    <AddedDate>sample string 4</AddedDate>
    <UpdatedDate>sample string 5</UpdatedDate>
    <Category>64</Category>
    <MarketDate>sample string 7</MarketDate>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <Tenure>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Tenure>
    <Price>8</Price>
    <DisplayPrice>sample string 9</DisplayPrice>
    <Address>
      <PropertyName>sample string 8</PropertyName>
      <Street>sample string 9</Street>
      <Locality>sample string 10</Locality>
      <Town>sample string 11</Town>
      <Region>sample string 12</Region>
      <Postcode>sample string 13</Postcode>
      <Country>sample string 1</Country>
      <CountryCode>2</CountryCode>
      <HouseNumber>sample string 3</HouseNumber>
      <StreetName>sample string 4</StreetName>
      <Latitude>5</Latitude>
      <Longitude>6</Longitude>
      <What3Words>sample string 7</What3Words>
    </Address>
    <DisplayAddress>sample string 10</DisplayAddress>
    <Description>sample string 11</Description>
    <Bedrooms>12</Bedrooms>
    <Bathrooms>13</Bathrooms>
    <Receptions>14</Receptions>
    <FloorArea>15</FloorArea>
    <LandArea>16</LandArea>
    <RentalFurnished>sample string 17</RentalFurnished>
    <RentalAvailableDate>sample string 18</RentalAvailableDate>
    <Pictures>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Pictures>
    <VirtualTours>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </VirtualTours>
  </PropertySearchResult>
  <PropertySearchResult>
    <ID>1</ID>
    <SitePrefix>sample string 2</SitePrefix>
    <BranchID>3</BranchID>
    <AddedDate>sample string 4</AddedDate>
    <UpdatedDate>sample string 5</UpdatedDate>
    <Category>64</Category>
    <MarketDate>sample string 7</MarketDate>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <Tenure>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Tenure>
    <Price>8</Price>
    <DisplayPrice>sample string 9</DisplayPrice>
    <Address>
      <PropertyName>sample string 8</PropertyName>
      <Street>sample string 9</Street>
      <Locality>sample string 10</Locality>
      <Town>sample string 11</Town>
      <Region>sample string 12</Region>
      <Postcode>sample string 13</Postcode>
      <Country>sample string 1</Country>
      <CountryCode>2</CountryCode>
      <HouseNumber>sample string 3</HouseNumber>
      <StreetName>sample string 4</StreetName>
      <Latitude>5</Latitude>
      <Longitude>6</Longitude>
      <What3Words>sample string 7</What3Words>
    </Address>
    <DisplayAddress>sample string 10</DisplayAddress>
    <Description>sample string 11</Description>
    <Bedrooms>12</Bedrooms>
    <Bathrooms>13</Bathrooms>
    <Receptions>14</Receptions>
    <FloorArea>15</FloorArea>
    <LandArea>16</LandArea>
    <RentalFurnished>sample string 17</RentalFurnished>
    <RentalAvailableDate>sample string 18</RentalAvailableDate>
    <Pictures>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Pictures>
    <VirtualTours>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </VirtualTours>
  </PropertySearchResult>
</ArrayOfPropertySearchResult>