logo

Back to Help Home Page.

GET Api/Offices/{id}

Gets the specified office.

Request Information

URI Parameters

NameDescriptionTypeAdditional information

id

The identifier of the office.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The requested office.

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

Id

integer

None.

Url

string

None.

Name

The name of the office.

string

Max length: 100

Address

The address of the office.

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

Required

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Url": "https://rental.chapps.com/api/Offices/1",
  "Name": "MyOfficeRef1",
  "Address": {
    "Street": "Ruschestrasse",
    "HouseNumber": 45,
    "ZipCode": "23957",
    "City": "Wismar",
    "Country": "DE"
  }
}

application/xml, text/xml

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