GET Api/EstateGroups?page={page}&pageSize={pageSize}&reference={reference}&officeId={officeId}

Retrieves estateGroups linked to provided login/business.

Request Information

URI Parameters

Name	Description	Type	Additional information
page	Optional: The page to retrieve.	integer	Default value is 0
pageSize	Optional: The number of estategroups on one page (max 100).	integer	Default value is 100
reference	Optional: the estategroup reference.	string	None.
officeId	Optional: the officeId the estategroup is linked to.	integer	None.

Body Parameters

None.

Response Information

Resource Description

A list of estategroups.

Collection of ChappReport.Site.Areas.Api.Models.V1.EstateV1ModelResponse

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
PartnerReference		string	Max length: 100
Address	The address of the estate.	ChappReport.Site.Areas.Api.Models.V1.AddressV1Model	Required
Type	The type of the estate (optional, default value: House). Possible values: House, Flat, Room, Studio, GarageBox, Catering, Office, Shop, Industry, CommercialProperty, Other.	string	None.
EstateGroupId	The id of the estategroup that the estate belongs to (optional).	integer	None.
OfficeId	The id of the office the estate is linked to (optional, requires Office product).	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Url": "https://rental.chapps.com/api/Estates/1",
    "Reference": "MyObjectRef1",
    "Address": {
      "Street": "Stadsplein",
      "HouseNumber": 1,
      "HouseNumberExtension": "a",
      "ZipCode": "8800",
      "City": "Roeselare",
      "Country": "BE"
    },
    "Type": "Studio"
  },
  {
    "Id": 2,
    "Url": "https://rental.chapps.com/api/Estates/2",
    "Reference": "MyObjectRef2",
    "Address": {
      "Street": "Ooststraat",
      "HouseNumber": 154,
      "Mailbox": "0021",
      "ZipCode": "2000",
      "City": "Antwerpen",
      "Country": "BE"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfEstateV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <EstateV1ModelResponse>
    <Address>
      <City>Roeselare</City>
      <Country>BE</Country>
      <HouseNumber>1</HouseNumber>
      <HouseNumberExtension>a</HouseNumberExtension>
      <Mailbox i:nil="true" />
      <State i:nil="true" />
      <Street>Stadsplein</Street>
      <ZipCode>8800</ZipCode>
    </Address>
    <EstateGroupId i:nil="true" />
    <OfficeId i:nil="true" />
    <PartnerReference i:nil="true" />
    <Reference>MyObjectRef1</Reference>
    <Type>Studio</Type>
    <Id>1</Id>
    <Url>https://rental.chapps.com/api/Estates/1</Url>
  </EstateV1ModelResponse>
  <EstateV1ModelResponse>
    <Address>
      <City>Antwerpen</City>
      <Country>BE</Country>
      <HouseNumber>154</HouseNumber>
      <HouseNumberExtension i:nil="true" />
      <Mailbox>0021</Mailbox>
      <State i:nil="true" />
      <Street>Ooststraat</Street>
      <ZipCode>2000</ZipCode>
    </Address>
    <EstateGroupId i:nil="true" />
    <OfficeId i:nil="true" />
    <PartnerReference i:nil="true" />
    <Reference>MyObjectRef2</Reference>
    <Type i:nil="true" />
    <Id>2</Id>
    <Url>https://rental.chapps.com/api/Estates/2</Url>
  </EstateV1ModelResponse>
</ArrayOfEstateV1ModelResponse>