POST api/ValidateAddress/ValidateAddress
Passes a JSON Object to the PFC Address Validation software to return a validated address
Request Information
URI Parameters
None.
Body Parameters
The SendObject class to send to the Validator
SendAddressName | Description | Type | Additional information |
---|---|---|---|
Address1 |
Main Address One |
string |
None. |
Address2 |
Main Address Two |
string |
None. |
Address3 |
Address Three |
string |
None. |
Address4 |
Address Four |
string |
None. |
Address5 |
Address Five |
string |
None. |
City |
Sender's City |
string |
None. |
StateProvince |
Sender's State or Province |
string |
None. |
PostalCode |
Sender's Zip Code |
string |
None. |
Country |
Sender's Country |
string |
None. |
AdministrativeArea |
Administration Code (Residential / Commercial) |
string |
None. |
OutputLanguage |
Output Language (Default is English) |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Address1": "sample string 1", "Address2": "sample string 2", "Address3": "sample string 3", "Address4": "sample string 4", "Address5": "sample string 5", "City": "sample string 6", "StateProvince": "sample string 7", "PostalCode": "sample string 8", "Country": "sample string 9", "AdministrativeArea": "sample string 10", "OutputLanguage": "sample string 11" }
application/xml, text/xml
Sample:
<SendAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SubmissionAPI.Models"> <Address1>sample string 1</Address1> <Address2>sample string 2</Address2> <Address3>sample string 3</Address3> <Address4>sample string 4</Address4> <Address5>sample string 5</Address5> <AdministrativeArea>sample string 10</AdministrativeArea> <City>sample string 6</City> <Country>sample string 9</Country> <OutputLanguage>sample string 11</OutputLanguage> <PostalCode>sample string 8</PostalCode> <StateProvince>sample string 7</StateProvince> </SendAddress>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |