GET api/PublicCompany/GetByPostcode?scheme={scheme}&postcode={postcode}&radius={radius}

Request Information

URI Parameters

Name	Type	Additional information
scheme	string	Required
postcode	string	Required
radius	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of CompanySearchDto

Name	Type	Additional information
CompanyId	globally unique identifier	None.
CompanyName	string	None.
TrimmedCompanyName	string	None.
FGasCode	string	None.
EliteCode	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
Town	string	None.
County	string	None.
Postcode	string	None.
TelephoneNo	string	None.
FaxNo	string	None.
Email	string	None.
Website	string	None.
FGas	boolean	None.
Elite	boolean	None.
Distance	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "companyId": "67a797d3-894b-44ab-9885-7f587fcd0647",
    "companyName": "sample string 2",
    "trimmedCompanyName": "sample string 3",
    "fGasCode": "sample string 4",
    "eliteCode": "sample string 5",
    "addressLine1": "sample string 6",
    "addressLine2": "sample string 7",
    "addressLine3": "sample string 8",
    "town": "sample string 9",
    "county": "sample string 10",
    "postcode": "sample string 11",
    "telephoneNo": "sample string 12",
    "faxNo": "sample string 13",
    "email": "sample string 14",
    "website": "sample string 15",
    "fGas": true,
    "elite": true,
    "distance": 18
  },
  {
    "companyId": "67a797d3-894b-44ab-9885-7f587fcd0647",
    "companyName": "sample string 2",
    "trimmedCompanyName": "sample string 3",
    "fGasCode": "sample string 4",
    "eliteCode": "sample string 5",
    "addressLine1": "sample string 6",
    "addressLine2": "sample string 7",
    "addressLine3": "sample string 8",
    "town": "sample string 9",
    "county": "sample string 10",
    "postcode": "sample string 11",
    "telephoneNo": "sample string 12",
    "faxNo": "sample string 13",
    "email": "sample string 14",
    "website": "sample string 15",
    "fGas": true,
    "elite": true,
    "distance": 18
  }
]

application/xml, text/xml

Sample:

<ArrayOfCompanySearchDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTO.Model">
  <CompanySearchDto>
    <AddressLine1>sample string 6</AddressLine1>
    <AddressLine2>sample string 7</AddressLine2>
    <AddressLine3>sample string 8</AddressLine3>
    <CompanyId>67a797d3-894b-44ab-9885-7f587fcd0647</CompanyId>
    <CompanyName>sample string 2</CompanyName>
    <County>sample string 10</County>
    <Distance>18</Distance>
    <Elite>true</Elite>
    <EliteCode>sample string 5</EliteCode>
    <Email>sample string 14</Email>
    <FGas>true</FGas>
    <FGasCode>sample string 4</FGasCode>
    <FaxNo>sample string 13</FaxNo>
    <Postcode>sample string 11</Postcode>
    <TelephoneNo>sample string 12</TelephoneNo>
    <Town>sample string 9</Town>
    <TrimmedCompanyName>sample string 3</TrimmedCompanyName>
    <Website>sample string 15</Website>
  </CompanySearchDto>
  <CompanySearchDto>
    <AddressLine1>sample string 6</AddressLine1>
    <AddressLine2>sample string 7</AddressLine2>
    <AddressLine3>sample string 8</AddressLine3>
    <CompanyId>67a797d3-894b-44ab-9885-7f587fcd0647</CompanyId>
    <CompanyName>sample string 2</CompanyName>
    <County>sample string 10</County>
    <Distance>18</Distance>
    <Elite>true</Elite>
    <EliteCode>sample string 5</EliteCode>
    <Email>sample string 14</Email>
    <FGas>true</FGas>
    <FGasCode>sample string 4</FGasCode>
    <FaxNo>sample string 13</FaxNo>
    <Postcode>sample string 11</Postcode>
    <TelephoneNo>sample string 12</TelephoneNo>
    <Town>sample string 9</Town>
    <TrimmedCompanyName>sample string 3</TrimmedCompanyName>
    <Website>sample string 15</Website>
  </CompanySearchDto>
</ArrayOfCompanySearchDto>