GET /businesses/search

Searches for businesses.

Authentication and Authorisation

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

Request Information

Parameters

Name Source Description
searchCriteria Part of the URI query string The search criteria.

Parameter Properties

  • searchCriteria
    • Keyword
      Keyword to be used for searching businesses.
      Remarks: Mandatory.
    • 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": [
    {
      "Name": "Bob's Skips Ltd",
      "Id": "b8453c3b-e49e-4d70-89a8-6567f43b0292"
    },
    {
      "Name": "Big Dave's Waste Solutions",
      "Id": "80f51cac-3325-4b81-bb0a-115484ff9289"
    },
    {
      "Name": "Skip n Tip",
      "Id": "93f8d8e6-6dcc-4c7a-b3cc-2afa3edd51ee"
    }
  ],
  "ResultsPerPage": 10,
  "PageIndex": 0,
  "TotalResults": 3
}
Sample:
<LinkedPagedResultOfBusinessSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="edoc">
  <PageIndex>0</PageIndex>
  <Results>
    <BusinessSearchResult>
      <Id>b8453c3b-e49e-4d70-89a8-6567f43b0292</Id>
      <Name>Bob's Skips Ltd</Name>
    </BusinessSearchResult>
    <BusinessSearchResult>
      <Id>80f51cac-3325-4b81-bb0a-115484ff9289</Id>
      <Name>Big Dave's Waste Solutions</Name>
    </BusinessSearchResult>
    <BusinessSearchResult>
      <Id>93f8d8e6-6dcc-4c7a-b3cc-2afa3edd51ee</Id>
      <Name>Skip n Tip</Name>
    </BusinessSearchResult>
  </Results>
  <ResultsPerPage>10</ResultsPerPage>
  <TotalResults>3</TotalResults>
  <NextPageUri>next</NextPageUri>
  <PreviousPageUri>prev</PreviousPageUri>
</LinkedPagedResultOfBusinessSearchResult>