POST /sites

Creates a new site for the current business.

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
site Part of the request HTTP body The site.

Parameter Properties

  • site
    • Active
      Indicates whether the site is active or not.
      Remarks: True by default, false implies not to be used in matches or suggestions.
    • Address
      Address of the site.
      Remarks: Mandatory.
      • Country
        Country of the address.
        Remarks: Mandatory for WTN submission.
      • LocalAuthorityArea
        Local authority area of the address
      • Line1
        First line of the address.
        Remarks: Mandatory.
      • Line2
        Second line of the address.
      • Line3
        Third line of the address.
      • Postcode
        Postcode of the address.
        Remarks: Mandatory.
    • EnvironmentalPermit
      Environmental permit for the site.
      • PermitNumber
        Number of the Environmental Permit.
    • ExemptionPermit
      Waste exemption permit for the site.
      • ExpiryDate
        Expiry date of the Exemption Permit
      • PermitNumber
        Number of the Exemption Permit
    • Id
      edoc generated unique identifier for the site.
    • KeepRecordsForLandfillTaxPurposes
      Indicating whether to keep records for this site for landfill tax purposes.
    • Name
      Name of the site.
      Remarks: Mandatory.
    • ParentSiteId
      edoc generated unique identifier for the parent site.
    • SicCode
      The SIC 2007 code for the site.
    • SignatureRequiredNotificationEmailAddresses
      Email addresses to be notified when a signature is required on a waste transfer note.
    • Size
      The size of the site.
    • TransferRecordAmendedNotificationEmailAddresses
      Email addresses to be notified when a waste transfer note is amended.

Request 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": "b43d9112-c750-4cf7-96e4-c586d6aeb4f8",
  "KeepRecordsForLandfillTaxPurposes": true,
  "Name": "Example 3",
  "ParentSiteId": "b5a040a9-b0a7-461e-ae66-c489021a823c",
  "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>b43d9112-c750-4cf7-96e4-c586d6aeb4f8</Id>
  <KeepRecordsForLandfillTaxPurposes>true</KeepRecordsForLandfillTaxPurposes>
  <Name>Example 3</Name>
  <ParentSiteId>b5a040a9-b0a7-461e-ae66-c489021a823c</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>