GET /sites/{id}

Gets a site from the edoc system.

Authentication and Authorisation

Requires API Access Token Requires Basic Authentication (Username/Password) Requires one of the following roles
True True BusinessAdministrator

Request Information

Parameters

Name Source Description
id Part of the URI route path The edoc generated unique identifier of the site.

Response Information

Response body formats

Sample:
{
  "Active": true,
  "Address": {
    "Country": "England",
    "LocalAuthorityArea": "Bath and North East Somerset",
    "Line1": "High Street",
    "Line2": "Bath",
    "Line3": "Somerset",
    "Postcode": "BA1 1AA"
  },
  "EnvironmentalPermit": {
    "PermitNumber": "Example 1"
  },
  "ExemptionPermit": {
    "ExpiryDate": "2019-08-18T00:00:00+00:00",
    "PermitNumber": "Example 1"
  },
  "Id": "1eaf9bad-9826-44b6-9a47-fa75b76ac415",
  "KeepRecordsForLandfillTaxPurposes": true,
  "Name": "Example 3",
  "ParentSiteId": "19b7cd0f-5d8e-4e78-a9cf-1e4b9f2821bd",
  "SicCode": "Example 5",
  "SignatureRequiredNotificationEmailAddresses": [
    "sample1@example.com",
    "sample2@example.com",
    "sample3@example.com"
  ],
  "Size": "OneToNine",
  "TransferRecordAmendedNotificationEmailAddresses": [
    "sample1@example.com",
    "sample2@example.com",
    "sample3@example.com"
  ]
}
Sample:
<Site xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="edoc">
  <Active>true</Active>
  <Address>
    <Country>England</Country>
    <Line1>High Street</Line1>
    <Line2>Bath</Line2>
    <Line3>Somerset</Line3>
    <LocalAuthorityArea>Bath and North East Somerset</LocalAuthorityArea>
    <Postcode>BA1 1AA</Postcode>
  </Address>
  <EnvironmentalPermit>
    <PermitNumber>Example 1</PermitNumber>
  </EnvironmentalPermit>
  <ExemptionPermit>
    <ExpiryDate>2019-08-18T00:00:00+00:00</ExpiryDate>
    <PermitNumber>Example 1</PermitNumber>
  </ExemptionPermit>
  <Id>1eaf9bad-9826-44b6-9a47-fa75b76ac415</Id>
  <KeepRecordsForLandfillTaxPurposes>true</KeepRecordsForLandfillTaxPurposes>
  <Name>Example 3</Name>
  <ParentSiteId>19b7cd0f-5d8e-4e78-a9cf-1e4b9f2821bd</ParentSiteId>
  <SicCode>Example 5</SicCode>
  <SignatureRequiredNotificationEmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample1@example.com</d2p1:string>
    <d2p1:string>sample2@example.com</d2p1:string>
    <d2p1:string>sample3@example.com</d2p1:string>
  </SignatureRequiredNotificationEmailAddresses>
  <Size>OneToNine</Size>
  <TransferRecordAmendedNotificationEmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample1@example.com</d2p1:string>
    <d2p1:string>sample2@example.com</d2p1:string>
    <d2p1:string>sample3@example.com</d2p1:string>
  </TransferRecordAmendedNotificationEmailAddresses>
</Site>