GET Api/Estates?page={page}&pageSize={pageSize}

Retrieves estates linked to provided login/business.

Remarks

GET api/estates

Request Information

URI Parameters

Name	Description	Type	Additional information
page	The page to retrieve.	integer	Default value is 0
pageSize	The number of estates on one page.	integer	Default value is 100

Body Parameters

None.

Response Information

Resource Description

A paged list of estates.

Collection of ChappReport.Site.Areas.Api.Models.EstateV2ModelResponse

Name	Description	Type	Additional information
Id	The Chapps identifier of the estate.	integer	None.
Url	Returns a direct link where the estate detail information can be retrieved.	string	None.
Reference	The reference of the broker,expert,... This will be shown on the report.	string	Max length: 100
Street		string	Required Max length: 100
HouseNumber		integer	None.
HouseNumberExtension		string	Max length: 10
Mailbox		string	Max length: 10
ZipCode		string	Required Max length: 10
City		string	Required Max length: 100
State	State or province. Format: US_CA	string	String length: inclusive between 5 and 5
Country	This fields complies to the list of ISO 2 DIGIT Country Codes (ISO 3166).	string	Required String length: inclusive between 2 and 2

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Url": "sample string 2",
    "Reference": "sample string 3",
    "Street": "sample string 4",
    "HouseNumber": 1,
    "HouseNumberExtension": "sample string 5",
    "Mailbox": "sample string 6",
    "ZipCode": "sample string 7",
    "City": "sample string 8",
    "State": "sample string 9",
    "Country": "sample string 10"
  },
  {
    "Id": 1,
    "Url": "sample string 2",
    "Reference": "sample string 3",
    "Street": "sample string 4",
    "HouseNumber": 1,
    "HouseNumberExtension": "sample string 5",
    "Mailbox": "sample string 6",
    "ZipCode": "sample string 7",
    "City": "sample string 8",
    "State": "sample string 9",
    "Country": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEstateV2ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models">
  <EstateV2ModelResponse>
    <City>sample string 8</City>
    <Country>sample string 10</Country>
    <HouseNumber>1</HouseNumber>
    <HouseNumberExtension>sample string 5</HouseNumberExtension>
    <Mailbox>sample string 6</Mailbox>
    <Reference>sample string 3</Reference>
    <State>sample string 9</State>
    <Street>sample string 4</Street>
    <ZipCode>sample string 7</ZipCode>
    <Id>1</Id>
    <Url>sample string 2</Url>
  </EstateV2ModelResponse>
  <EstateV2ModelResponse>
    <City>sample string 8</City>
    <Country>sample string 10</Country>
    <HouseNumber>1</HouseNumber>
    <HouseNumberExtension>sample string 5</HouseNumberExtension>
    <Mailbox>sample string 6</Mailbox>
    <Reference>sample string 3</Reference>
    <State>sample string 9</State>
    <Street>sample string 4</Street>
    <ZipCode>sample string 7</ZipCode>
    <Id>1</Id>
    <Url>sample string 2</Url>
  </EstateV2ModelResponse>
</ArrayOfEstateV2ModelResponse>