POST Api/EstateGroups

Inserts a new estateGroup.

Request Information

URI Parameters

None.

Body Parameters

The estateGroup.

ChappReport.Site.Areas.Api.Models.V1.EstateGroupV1ModelRequest

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

Request Formats

application/json, text/json

Sample:

{
  "Reference": "MyEstateGroupRef1",
  "Address": {
    "Street": "Ruschestrasse",
    "HouseNumber": 45,
    "ZipCode": "23957",
    "City": "Wismar",
    "Country": "DE"
  }
}

application/xml, text/xml

Sample:

<EstateGroupV1ModelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <Address>
    <City>Wismar</City>
    <Country>DE</Country>
    <HouseNumber>45</HouseNumber>
    <HouseNumberExtension i:nil="true" />
    <Mailbox i:nil="true" />
    <State i:nil="true" />
    <Street>Ruschestrasse</Street>
    <ZipCode>23957</ZipCode>
  </Address>
  <OfficeId i:nil="true" />
  <Reference>MyEstateGroupRef1</Reference>
</EstateGroupV1ModelRequest>

Response Information

Resource Description

The id of the created estateGroup. In the location header is a uri where the estateGroup 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>