Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
key | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Street | form | string | No | |
Street2 | form | string | No | |
Secondary | form | string | No | |
City | form | string | No | |
State | form | string | No | |
ZipCode | form | string | No | |
Lastline | form | string | No | |
Addressee | form | string | No | |
Urbanization | form | string | No | |
MatchStrategy | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: www.bernhardthospitality.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: ValidateAddress
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ValidateAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Emun.SmartyStreets">
<addressee xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</addressee>
<candidates xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">1</candidates>
<city xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</city>
<lastline xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</lastline>
<match xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</match>
<secondary xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</secondary>
<state xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</state>
<street xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</street>
<street2 xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</street2>
<urbanization xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</urbanization>
<zipcode xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi">String</zipcode>
<key>String</key>
</ValidateAddress>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ArrayOfCandidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartyStreets.USStreetApi"> <Candidate> <addressee>String</addressee> <analysis> <active>String</active> <dpv_cmra>String</dpv_cmra> <dpv_footnotes>String</dpv_footnotes> <dpv_match_code>String</dpv_match_code> <dpv_vacant>String</dpv_vacant> <ews_match>false</ews_match> <footnotes>String</footnotes> <lacslink_code>String</lacslink_code> <lacslink_indicator>String</lacslink_indicator> <suitelink_match>false</suitelink_match> </analysis> <candidate_index>0</candidate_index> <components> <city_name>String</city_name> <default_city_name>String</default_city_name> <delivery_point>String</delivery_point> <delivery_point_check_digit>String</delivery_point_check_digit> <extra_secondary_designator>String</extra_secondary_designator> <extra_secondary_number>String</extra_secondary_number> <plus4_code>String</plus4_code> <pmb_designator>String</pmb_designator> <pmb_number>String</pmb_number> <primary_number>String</primary_number> <secondary_designator>String</secondary_designator> <secondary_number>String</secondary_number> <state_abbreviation>String</state_abbreviation> <street_name>String</street_name> <street_postdirection>String</street_postdirection> <street_predirection>String</street_predirection> <street_suffix>String</street_suffix> <urbanization>String</urbanization> <zipcode>String</zipcode> </components> <delivery_line_1>String</delivery_line_1> <delivery_line_2>String</delivery_line_2> <delivery_point_barcode>String</delivery_point_barcode> <input_id>String</input_id> <input_index>0</input_index> <last_line>String</last_line> <metadata> <building_default_indicator>String</building_default_indicator> <carrier_route>String</carrier_route> <congressional_district>String</congressional_district> <county_fips>String</county_fips> <county_name>String</county_name> <dst>false</dst> <elot_sequence>String</elot_sequence> <elot_sort>String</elot_sort> <ews_match>false</ews_match> <latitude>0</latitude> <longitude>0</longitude> <precision>String</precision> <rdi>String</rdi> <record_type>String</record_type> <time_zone>String</time_zone> <utc_offset>0</utc_offset> <zip_type>String</zip_type> </metadata> </Candidate> </ArrayOfCandidate> </soap:Body> </soap:Envelope>