GET api/PublicCompany/GetAddress/{reference}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
reference

string

Required

Body Parameters

None.

Response Information

Resource Description

CompanyAddressDto
NameDescriptionTypeAdditional information
HvCode

string

None.

CompanyName

string

None.

AddressLine1

string

None.

AddressLine2

string

None.

AddressLine3

string

None.

Town

string

None.

County

string

None.

Postcode

string

None.

RefcomCertificateNumber

string

None.

Response Formats

application/json, text/json

Sample:
{
  "hvCode": "sample string 1",
  "companyName": "sample string 2",
  "addressLine1": "sample string 3",
  "addressLine2": "sample string 4",
  "addressLine3": "sample string 5",
  "town": "sample string 6",
  "county": "sample string 7",
  "postcode": "sample string 8",
  "refcomCertificateNumber": "sample string 9"
}

application/xml, text/xml

Sample:
<CompanyAddressDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTO.Model">
  <AddressLine1>sample string 3</AddressLine1>
  <AddressLine2>sample string 4</AddressLine2>
  <AddressLine3>sample string 5</AddressLine3>
  <CompanyName>sample string 2</CompanyName>
  <County>sample string 7</County>
  <HvCode>sample string 1</HvCode>
  <Postcode>sample string 8</Postcode>
  <RefcomCertificateNumber>sample string 9</RefcomCertificateNumber>
  <Town>sample string 6</Town>
</CompanyAddressDto>