POST api/Addresses/AddressValidationSummary

Returns a list of address descriptions based on an input postcode.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Postcode	string	None.
CountryCode	string	None.
InputType	PostcodeLookup.AddressValidatorParams+ValidationSummaryTypeEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "Postcode": "sample string 1",
  "CountryCode": "sample string 2",
  "InputType": 0
}

application/xml, text/xml

Sample:

<AddressValidatorParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PostcodeLookup">
  <CountryCode>sample string 2</CountryCode>
  <InputType>Empty</InputType>
  <Postcode>sample string 1</Postcode>
</AddressValidatorParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PostcodeLookup.AddressValidationSummary

Name	Type	Additional information
ID	string	None.
Description	string	None.
SummaryType	PostcodeLookup.AddressValidatorParams+ValidationSummaryTypeEnum	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": "sample string 1",
    "Description": "sample string 2",
    "SummaryType": 0
  },
  {
    "ID": "sample string 1",
    "Description": "sample string 2",
    "SummaryType": 0
  }
]

application/xml, text/xml

Sample:

<ArrayOfAddressValidationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PostcodeLookup">
  <AddressValidationSummary>
    <Description>sample string 2</Description>
    <ID>sample string 1</ID>
    <SummaryType>Empty</SummaryType>
  </AddressValidationSummary>
  <AddressValidationSummary>
    <Description>sample string 2</Description>
    <ID>sample string 1</ID>
    <SummaryType>Empty</SummaryType>
  </AddressValidationSummary>
</ArrayOfAddressValidationSummary>