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

Description

Gets a list of all property areas 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 PropertyArea
Name Description Type Additional information
ID

integer

None.
Description

string

None.
FullDescription

string

None.
PropertyAreaID

integer

None.
BranchID

integer

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 2",
    "fullDescription": "sample string 3",
    "propertyAreaID": 4,
    "branchID": 5
  },
  {
    "id": 1,
    "description": "sample string 2",
    "fullDescription": "sample string 3",
    "propertyAreaID": 4,
    "branchID": 5
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPropertyArea xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PropertyArea>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <FullDescription>sample string 3</FullDescription>
    <PropertyAreaID>4</PropertyAreaID>
    <BranchID>5</BranchID>
  </PropertyArea>
  <PropertyArea>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <FullDescription>sample string 3</FullDescription>
    <PropertyAreaID>4</PropertyAreaID>
    <BranchID>5</BranchID>
  </PropertyArea>
</ArrayOfPropertyArea>