logo

Back to Help Home Page.

POST Api/Offices

Creates a new office.

Request Information

URI Parameters

None.

Body Parameters

The office.

ChappReport.Site.Areas.Api.Models.V1.OfficeV1ModelRequest
NameDescriptionTypeAdditional information

Name

The name of the office.

string

Max length: 100

Address

The address of the office.

ChappReport.Site.Areas.Api.Models.V1.AddressV1Model

Required

Request Formats

application/json, text/json

Sample:
{
  "Name": "MyOfficeRef1",
  "Address": {
    "Street": "Stadsplein",
    "HouseNumber": 1,
    "HouseNumberExtension": "a",
    "ZipCode": "8800",
    "City": "Roeselare",
    "Country": "BE"
  }
}

application/xml, text/xml

Sample:
<OfficeV1ModelRequest 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>
  <Name>MyOfficeRef1</Name>
</OfficeV1ModelRequest>

Response Information

Resource Description

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

ChappReport.Site.Areas.Api.Models.V1.CreatedResponse
NameDescriptionTypeAdditional 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>