All Verbs | /service/ValidateAddress |
---|
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/ValidateAddress HTTP/1.1
Host: www.bernhardthospitality.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"key":"String","result":[],"inputId":"String","street":"String","street2":"String","secondary":"String","city":"String","state":"String","zipCode":"String","lastline":"String","addressee":"String","urbanization":"String","matchStrategy":"String","maxCandidates":1}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length [{"input_id":"String","input_index":0,"candidate_index":0,"addressee":"String","delivery_line_1":"String","delivery_line_2":"String","last_line":"String","delivery_point_barcode":"String","components":{"urbanization":"String","primary_number":"String","street_name":"String","street_predirection":"String","street_postdirection":"String","street_suffix":"String","secondary_number":"String","secondary_designator":"String","extra_secondary_number":"String","extra_secondary_designator":"String","pmb_designator":"String","pmb_number":"String","city_name":"String","default_city_name":"String","state_abbreviation":"String","zipcode":"String","plus4_code":"String","delivery_point":"String","delivery_point_check_digit":"String"},"metadata":{"record_type":"String","zip_type":"String","county_fips":"String","county_name":"String","carrier_route":"String","congressional_district":"String","building_default_indicator":"String","rdi":"String","elot_sequence":"String","elot_sort":"String","latitude":0,"longitude":0,"precision":"String","time_zone":"String","utc_offset":0,"dst":false,"ews_match":false},"analysis":{"dpv_match_code":"String","dpv_footnotes":"String","dpv_cmra":"String","dpv_vacant":"String","active":"String","ews_match":false,"footnotes":"String","lacslink_code":"String","lacslink_indicator":"String","suitelink_match":false}}]