GET /businesses/{id}/sites

Searches for a site in the given Business.

Authentication and Authorisation

Requires API Access Token Requires Basic Authentication (Username/Password)
True True

Request Information

Parameters

Name Source Description
id Part of the URI route path the edoc generated unique identifier of the business.
searchCriteria Part of the URI query string The search criteria.

Parameter Properties

  • searchCriteria
    • Keyword
      Keyword to be used for searching.
      Remarks: Mandatory.
    • ParentSiteId
      edoc generated unique identifier for the parent site.
    • PageIndex
      Zero-based page index.
    • ResultsPerPage
      Number of results per page.
      Remarks: Mandatory. Accepted range is 1 to 100.

Response Information

Response body formats

Sample:
{
  "NextPageUri": "next",
  "PreviousPageUri": "prev",
  "Results": [
    {
      "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": "348419c5-1db7-4ed1-9029-91db02b71a28",
      "Name": "Example 2",
      "ParentSiteId": "9bceefd1-5fe3-4827-aa8a-d072afe15f7f",
      "Size": "OneToNine",
      "KeepRecordsForLandfillTaxPurposes": true
    },
    {
      "Active": true,
      "Address": {
        "Country": "England",
        "LocalAuthorityArea": "Bristol, City of",
        "Line1": "Temple Street",
        "Line2": "Bristol",
        "Line3": "Somerset",
        "Postcode": "BS1 1BB"
      },
      "EnvironmentalPermit": {
        "PermitNumber": "Example 1"
      },
      "ExemptionPermit": {
        "ExpiryDate": "2019-08-18T00:00:00+00:00",
        "PermitNumber": "Example 1"
      },
      "Id": "46a71de4-da7f-49fc-b3e5-d9ea8d0b078f",
      "Name": "Example 2",
      "ParentSiteId": "5ab2589c-4dd1-42d0-a4ce-f8374e3a238c",
      "Size": "OneToNine",
      "KeepRecordsForLandfillTaxPurposes": true
    },
    {
      "Active": true,
      "Address": {
        "Country": "England",
        "LocalAuthorityArea": "Southampton",
        "Line1": "Commercial Road",
        "Line2": "Southampton",
        "Line3": "Hampshire",
        "Postcode": "SO15 1EZ"
      },
      "EnvironmentalPermit": {
        "PermitNumber": "Example 1"
      },
      "ExemptionPermit": {
        "ExpiryDate": "2019-08-18T00:00:00+00:00",
        "PermitNumber": "Example 1"
      },
      "Id": "7cc4af4c-0150-4356-b95e-c0601b31beef",
      "Name": "Example 2",
      "ParentSiteId": "e833f2b8-4c99-4b34-8605-10f7c87deede",
      "Size": "OneToNine",
      "KeepRecordsForLandfillTaxPurposes": true
    }
  ],
  "ResultsPerPage": 10,
  "PageIndex": 0,
  "TotalResults": 3
}
Sample:
<LinkedPagedResultOfSiteSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="edoc">
  <PageIndex>0</PageIndex>
  <Results>
    <SiteSearchResult>
      <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>348419c5-1db7-4ed1-9029-91db02b71a28</Id>
      <KeepRecordsForLandfillTaxPurposes>true</KeepRecordsForLandfillTaxPurposes>
      <Name>Example 2</Name>
      <ParentSiteId>9bceefd1-5fe3-4827-aa8a-d072afe15f7f</ParentSiteId>
      <Size>OneToNine</Size>
    </SiteSearchResult>
    <SiteSearchResult>
      <Active>true</Active>
      <Address>
        <Country>England</Country>
        <Line1>Temple Street</Line1>
        <Line2>Bristol</Line2>
        <Line3>Somerset</Line3>
        <LocalAuthorityArea>Bristol, City of</LocalAuthorityArea>
        <Postcode>BS1 1BB</Postcode>
      </Address>
      <EnvironmentalPermit>
        <PermitNumber>Example 1</PermitNumber>
      </EnvironmentalPermit>
      <ExemptionPermit>
        <ExpiryDate>2019-08-18T00:00:00+00:00</ExpiryDate>
        <PermitNumber>Example 1</PermitNumber>
      </ExemptionPermit>
      <Id>46a71de4-da7f-49fc-b3e5-d9ea8d0b078f</Id>
      <KeepRecordsForLandfillTaxPurposes>true</KeepRecordsForLandfillTaxPurposes>
      <Name>Example 2</Name>
      <ParentSiteId>5ab2589c-4dd1-42d0-a4ce-f8374e3a238c</ParentSiteId>
      <Size>OneToNine</Size>
    </SiteSearchResult>
    <SiteSearchResult>
      <Active>true</Active>
      <Address>
        <Country>England</Country>
        <Line1>Commercial Road</Line1>
        <Line2>Southampton</Line2>
        <Line3>Hampshire</Line3>
        <LocalAuthorityArea>Southampton</LocalAuthorityArea>
        <Postcode>SO15 1EZ</Postcode>
      </Address>
      <EnvironmentalPermit>
        <PermitNumber>Example 1</PermitNumber>
      </EnvironmentalPermit>
      <ExemptionPermit>
        <ExpiryDate>2019-08-18T00:00:00+00:00</ExpiryDate>
        <PermitNumber>Example 1</PermitNumber>
      </ExemptionPermit>
      <Id>7cc4af4c-0150-4356-b95e-c0601b31beef</Id>
      <KeepRecordsForLandfillTaxPurposes>true</KeepRecordsForLandfillTaxPurposes>
      <Name>Example 2</Name>
      <ParentSiteId>e833f2b8-4c99-4b34-8605-10f7c87deede</ParentSiteId>
      <Size>OneToNine</Size>
    </SiteSearchResult>
  </Results>
  <ResultsPerPage>10</ResultsPerPage>
  <TotalResults>3</TotalResults>
  <NextPageUri>next</NextPageUri>
  <PreviousPageUri>prev</PreviousPageUri>
</LinkedPagedResultOfSiteSearchResult>