POST v1/AddressValidation

Validate provided address and suggest new address.

Request Information

URI Parameters

None.

Body Parameters

addressValidationInput
NameDescriptionTypeAdditional information
line1

string

None.

line2

string

None.

line3

string

None.

city

string

None.

stateProvince

string

None.

postalCode

string

None.

county

string

None.

country

string

None.

Request Formats

application/json, text/json

Sample:
{
  "line1": "sample string 1",
  "line2": "sample string 2",
  "line3": "sample string 3",
  "city": "sample string 4",
  "stateProvince": "sample string 5",
  "postalCode": "sample string 6",
  "county": "sample string 7",
  "country": "sample string 8"
}

text/html

Sample:
{"line1":"sample string 1","line2":"sample string 2","line3":"sample string 3","city":"sample string 4","stateProvince":"sample string 5","postalCode":"sample string 6","county":"sample string 7","country":"sample string 8"}

application/xml, text/xml

Sample:
<v1_Address_AddressValidationEndpointController.addressValidationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Address_AddressValidationEndpoint">
  <city>sample string 4</city>
  <country>sample string 8</country>
  <county>sample string 7</county>
  <line1>sample string 1</line1>
  <line2>sample string 2</line2>
  <line3>sample string 3</line3>
  <postalCode>sample string 6</postalCode>
  <stateProvince>sample string 5</stateProvince>
</v1_Address_AddressValidationEndpointController.addressValidationInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'addressValidationInput'.

Response Information

Resource Description

addressValidationOutput
NameDescriptionTypeAdditional information
status

The validation status of address

string

None.

line1

The line1 of this address

string

None.

line2

The line2 of this address

string

None.

line3

The line3 of this address

string

None.

city

The city of this address

string

None.

stateProvince

The state province of this address

string

None.

postalCode

The postal code of this address

string

None.

county

The county of this address

string

None.

country

The country of this address

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": "sample string 1",
  "line1": "sample string 2",
  "line2": "sample string 3",
  "line3": "sample string 4",
  "city": "sample string 5",
  "stateProvince": "sample string 6",
  "postalCode": "sample string 7",
  "county": "sample string 8",
  "country": "sample string 9"
}

text/html

Sample:
{"status":"sample string 1","line1":"sample string 2","line2":"sample string 3","line3":"sample string 4","city":"sample string 5","stateProvince":"sample string 6","postalCode":"sample string 7","county":"sample string 8","country":"sample string 9"}

application/xml, text/xml

Sample:
<v1_Address_AddressValidationEndpointController.addressValidationOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Address_AddressValidationEndpoint">
  <city>sample string 5</city>
  <country>sample string 9</country>
  <county>sample string 8</county>
  <line1>sample string 2</line1>
  <line2>sample string 3</line2>
  <line3>sample string 4</line3>
  <postalCode>sample string 7</postalCode>
  <stateProvince>sample string 6</stateProvince>
  <status>sample string 1</status>
</v1_Address_AddressValidationEndpointController.addressValidationOutput>