POST Api/Estates

Inserts a new estate.

Request Information

URI Parameters

None.

Body Parameters

The estate.

ChappReport.Site.Areas.Api.Models.V1.EstateV1ModelRequest

Name	Description	Type	Additional information
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.

Request Formats

application/json, text/json

Sample:

{
  "Reference": "MyObjectRef1",
  "Address": {
    "Street": "Stadsplein",
    "HouseNumber": 1,
    "HouseNumberExtension": "a",
    "ZipCode": "8800",
    "City": "Roeselare",
    "Country": "BE"
  },
  "Type": "Studio"
}

application/xml, text/xml

Sample:

<EstateV1ModelRequest 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>
</EstateV1ModelRequest>

Response Information

Resource Description

The id of the created estate. In the location header is a uri where the estate can be retrieved.

ChappReport.Site.Areas.Api.Models.V1.CreatedResponse

Name	Description	Type	Additional information
Id		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1
}

application/xml, text/xml

Sample:

<CreatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <Id>1</Id>
</CreatedResponse>