(Visual FoxPro) Shippo Validate Global Address

Demonstrates how to validate a global address.

For more information, see https://goshippo.com/docs/address-validation/

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loReq
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcSource
LOCAL lcV_type
LOCAL lcCode
LOCAL lcText
LOCAL lcObject_created
LOCAL lcObject_updated
LOCAL lcObject_id
LOCAL lnIs_complete
LOCAL lnValidation_resultsIs_valid
LOCAL lcObject_owner
LOCAL lcName
LOCAL lcCompany
LOCAL lcStreet_no
LOCAL lcStreet1
LOCAL lcStreet2
LOCAL lcStreet3
LOCAL lcCity
LOCAL lcState
LOCAL lcZip
LOCAL lcCountry
LOCAL lcLongitude
LOCAL lcLatitude
LOCAL lcPhone
LOCAL lcEmail
LOCAL lcIs_residential
LOCAL lcMetadata
LOCAL lnTest
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Implements the following CURL command:

* curl https://api.goshippo.com/addresses/ \
*     -H "Authorization: ShippoToken <API_TOKEN>" \
*     -d name="Shawn Ippotle" \
*     -d company="Shippo" \
*     -d street1="Kortrijksesteenweg 1005" \
*     -d city="Gent" \
*     -d zip=9000 \
*     -d country="BE" \
*     -d email="shippotle@goshippo.com"\
*     -d validate=true

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.HttpRequest')
loReq = CreateObject('Chilkat.HttpRequest')
loReq.HttpVerb = "POST"
loReq.Path = "/addresses/"
loReq.ContentType = "application/x-www-form-urlencoded"
loReq.AddParam("name","Shawn Ippotle")
loReq.AddParam("company","Shippo")
loReq.AddParam("street1","Kortrijksesteenweg 1005")
loReq.AddParam("city","Gent")
loReq.AddParam("zip","9000")
loReq.AddParam("country","BE")
loReq.AddParam("email","shippotle@goshippo.com")
loReq.AddParam("validate","true")

loReq.AddHeader("Authorization","ShippoToken <API_TOKEN>")

loResp = loHttp.PostUrlEncoded("https://api.goshippo.com/addresses/",loReq)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loReq
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*   "object_created": "2017-07-26T17:52:37.305Z",
*   "object_updated": "2017-07-26T17:52:37.351Z",
*   "object_id": "b7f9709df3914d1ca6efe4c30e7b0572",
*   "is_complete": true,
*   "validation_results": {
*     "is_valid": true,
*     "messages": [
*       {
*         "source": "Shippo Address Validator",
*         "type": "address_correction",
*         "code": "administrative_area_change",
*         "text": "The administrative area (state or province) was added or changed."
*       },
*       {
*         "source": "Shippo Address Validator",
*         "code": "geocoded_rooftop",
*         "text": "The record was geocoded down to rooftop level, meaning the point is within the property boundaries (most often the center)."
*       },
*       {
*         "source": "Shippo Address Validator",
*         "code": "premises_full",
*         "text": "The address has been verified to the Premise (House or Building) Level, which is the highest level possible with the reference data."
*       }
*     ]
*   },
*   "object_owner": "hippo@goshippo.com",
*   "name": "Hippo Shippo",
*   "company": "Shippo",
*   "street_no": "2",
*   "street1": "Unter den Linden",
*   "street2": "",
*   "street3": "",
*   "city": "Berlin",
*   "state": "",
*   "zip": "10117",
*   "country": "DE",
*   "longitude": "13.39751",
*   "latitude": "52.51785",
*   "phone": "14151234567",
*   "email": "hippo@goshippo.com",
*   "is_residential": null,
*   "metadata": "",
*   "test": false
* }

* Sample code for parsing the JSON response...
* Use the following online tool to generate parsing code from sample JSON:
* Generate Parsing Code from JSON

lcObject_created = loJResp.StringOf("object_created")
lcObject_updated = loJResp.StringOf("object_updated")
lcObject_id = loJResp.StringOf("object_id")
lnIs_complete = loJResp.BoolOf("is_complete")
lnValidation_resultsIs_valid = loJResp.BoolOf("validation_results.is_valid")
lcObject_owner = loJResp.StringOf("object_owner")
lcName = loJResp.StringOf("name")
lcCompany = loJResp.StringOf("company")
lcStreet_no = loJResp.StringOf("street_no")
lcStreet1 = loJResp.StringOf("street1")
lcStreet2 = loJResp.StringOf("street2")
lcStreet3 = loJResp.StringOf("street3")
lcCity = loJResp.StringOf("city")
lcState = loJResp.StringOf("state")
lcZip = loJResp.StringOf("zip")
lcCountry = loJResp.StringOf("country")
lcLongitude = loJResp.StringOf("longitude")
lcLatitude = loJResp.StringOf("latitude")
lcPhone = loJResp.StringOf("phone")
lcEmail = loJResp.StringOf("email")
lcIs_residential = loJResp.StringOf("is_residential")
lcMetadata = loJResp.StringOf("metadata")
lnTest = loJResp.BoolOf("test")
i = 0
lnCount_i = loJResp.SizeOfArray("validation_results.messages")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcSource = loJResp.StringOf("validation_results.messages[i].source")
    lcV_type = loJResp.StringOf("validation_results.messages[i].type")
    lcCode = loJResp.StringOf("validation_results.messages[i].code")
    lcText = loJResp.StringOf("validation_results.messages[i].text")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loReq
RELEASE loSbResponseBody
RELEASE loJResp