GET 1.0/website/propertydevelopments?branchid={branchid}

Description

Gets all property developments for an agent

URI Parameters

Name Description Type Additional information
branchId

id of the branch for the agent

integer

Default value is -1

None.

None.

Collection of PropertyDevelopment
Name Description Type Additional information
ID

integer

None.

BriefDescription

string

None.

FullDescription

string

None.

Address

Address

None.

Area

IDDescriptionPair

None.

BranchID

integer

None.

application/json, text/json

Sample:
[
  {
    "id": 1,
    "briefDescription": "sample string 2",
    "fullDescription": "sample string 3",
    "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"
    },
    "area": {
      "id": 1,
      "description": "sample string 2"
    },
    "branchID": 4
  },
  {
    "id": 1,
    "briefDescription": "sample string 2",
    "fullDescription": "sample string 3",
    "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"
    },
    "area": {
      "id": 1,
      "description": "sample string 2"
    },
    "branchID": 4
  }
]

application/xml, text/xml

Sample:
<ArrayOfPropertyDevelopment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PropertyDevelopment>
    <ID>1</ID>
    <BriefDescription>sample string 2</BriefDescription>
    <FullDescription>sample string 3</FullDescription>
    <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>
    <Area>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Area>
    <BranchID>4</BranchID>
  </PropertyDevelopment>
  <PropertyDevelopment>
    <ID>1</ID>
    <BriefDescription>sample string 2</BriefDescription>
    <FullDescription>sample string 3</FullDescription>
    <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>
    <Area>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Area>
    <BranchID>4</BranchID>
  </PropertyDevelopment>
</ArrayOfPropertyDevelopment>