GET Api/EstateGroups/{id}

Gets the specified estateGroup.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The identifier of the estateGroup.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The requested estateGroup.

ChappReport.Site.Areas.Api.Models.V1.EstateGroupV1ModelResponse

Name	Description	Type	Additional information
Id	The Chapps identifier of the estateGroup.	integer	None.
Url	Returns a direct link where the estateGroup 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
Address	The address of the estateGroup.	ChappReport.Site.Areas.Api.Models.V1.AddressV1Model	Required
OfficeId	The id of the office the estategroup is linked to (optional, requires Office product).	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Url": "https://rental.chapps.com/api/EstateGroups/1",
  "Reference": "MyEstateGroupRef1",
  "Address": {
    "Street": "Stadsplein",
    "HouseNumber": 1,
    "HouseNumberExtension": "a",
    "ZipCode": "8800",
    "City": "Roeselare",
    "Country": "BE"
  }
}

application/xml, text/xml

Sample:

<EstateGroupV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <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>
  <OfficeId i:nil="true" />
  <Reference>MyEstateGroupRef1</Reference>
  <Id>1</Id>
  <Url>https://rental.chapps.com/api/EstateGroups/1</Url>
</EstateGroupV1ModelResponse>