logo

Back to Help Home Page.

GET Api/Offices

Retrieves offices linked to provided login/business.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of offices.

Collection of 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": "Stadsplein",
      "HouseNumber": 1,
      "HouseNumberExtension": "a",
      "ZipCode": "8800",
      "City": "Roeselare",
      "Country": "BE"
    }
  },
  {
    "Id": 2,
    "Url": "https://rental.chapps.com/api/Offices/2",
    "Name": "MyOfficeRef2",
    "Address": {
      "Street": "Ooststraat",
      "HouseNumber": 154,
      "Mailbox": "0021",
      "ZipCode": "2000",
      "City": "Antwerpen",
      "Country": "BE"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfOfficeV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <OfficeV1ModelResponse>
    <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>
  </OfficeV1ModelResponse>
  <OfficeV1ModelResponse>
    <Address>
      <City>Antwerpen</City>
      <Country>BE</Country>
      <HouseNumber>154</HouseNumber>
      <HouseNumberExtension i:nil="true" />
      <Mailbox>0021</Mailbox>
      <State i:nil="true" />
      <Street>Ooststraat</Street>
      <ZipCode>2000</ZipCode>
    </Address>
    <Name>MyOfficeRef2</Name>
  </OfficeV1ModelResponse>
</ArrayOfOfficeV1ModelResponse>