Gets the specified estate.
Name | Description | Type | Additional information |
---|---|---|---|
id |
The identifier of the estate. |
integer |
Required |
None.
The requested estate.
ChappReport.Site.Areas.Api.Models.V1.EstateV1ModelResponseName | 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. |
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. |
{ "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" }
<EstateV1ModelResponse 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> <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>