Xbase++

Shippo Validate Global Address

See more Shippo Examples

Demonstrates how to validate a global address. Xbase++

LOCAL nSuccess
LOCAL oHttp
LOCAL oReq
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cSource
LOCAL cV_type
LOCAL cCode
LOCAL cText
LOCAL cObject_created
LOCAL cObject_updated
LOCAL cObject_id
LOCAL nIs_complete
LOCAL nValidation_resultsIs_valid
LOCAL cObject_owner
LOCAL cName
LOCAL cCompany
LOCAL cStreet_no
LOCAL cStreet1
LOCAL cStreet2
LOCAL cStreet3
LOCAL cCity
LOCAL cState
LOCAL cZip
LOCAL cCountry
LOCAL cLongitude
LOCAL cLatitude
LOCAL cPhone
LOCAL cEmail
LOCAL cIs_residential
LOCAL cMetadata
LOCAL nTest
LOCAL i
LOCAL nCount_i

nSuccess := 0

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

oHttp := 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

oReq := CreateObject("Chilkat.HttpRequest")
oReq:HttpVerb := "POST"
oReq:Path := "/addresses/"
oReq:ContentType := "application/x-www-form-urlencoded"
oReq:AddParam("name", "Shawn Ippotle")
oReq:AddParam("company", "Shippo")
oReq:AddParam("street1", "Kortrijksesteenweg 1005")
oReq:AddParam("city", "Gent")
oReq:AddParam("zip", "9000")
oReq:AddParam("country", "BE")
oReq:AddParam("email", "shippotle@goshippo.com")
oReq:AddParam("validate", "true")

oReq:AddHeader("Authorization", "ShippoToken <API_TOKEN>")

oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpReq("https://api.goshippo.com/addresses/", oReq, oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oReq:destroy()
    oResp:destroy()
    RETURN
ENDIF

oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oResp:GetBodySb(oSbResponseBody)
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0

? "Response Body:"
? oJResp:Emit()

nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
    ? "Response Header:"
    ? oResp:Header
    ? "Failed."
    oHttp:destroy()
    oReq:destroy()
    oResp:destroy()
    oSbResponseBody:destroy()
    oJResp:destroy()
    RETURN
ENDIF

//  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

cObject_created := oJResp:StringOf("object_created")
cObject_updated := oJResp:StringOf("object_updated")
cObject_id := oJResp:StringOf("object_id")
nIs_complete := oJResp:BoolOf("is_complete")
nValidation_resultsIs_valid := oJResp:BoolOf("validation_results.is_valid")
cObject_owner := oJResp:StringOf("object_owner")
cName := oJResp:StringOf("name")
cCompany := oJResp:StringOf("company")
cStreet_no := oJResp:StringOf("street_no")
cStreet1 := oJResp:StringOf("street1")
cStreet2 := oJResp:StringOf("street2")
cStreet3 := oJResp:StringOf("street3")
cCity := oJResp:StringOf("city")
cState := oJResp:StringOf("state")
cZip := oJResp:StringOf("zip")
cCountry := oJResp:StringOf("country")
cLongitude := oJResp:StringOf("longitude")
cLatitude := oJResp:StringOf("latitude")
cPhone := oJResp:StringOf("phone")
cEmail := oJResp:StringOf("email")
cIs_residential := oJResp:StringOf("is_residential")
cMetadata := oJResp:StringOf("metadata")
nTest := oJResp:BoolOf("test")
i := 0
nCount_i := oJResp:SizeOfArray("validation_results.messages")
DO WHILE i < nCount_i
    oJResp:I := i
    cSource := oJResp:StringOf("validation_results.messages[i].source")
    cV_type := oJResp:StringOf("validation_results.messages[i].type")
    cCode := oJResp:StringOf("validation_results.messages[i].code")
    cText := oJResp:StringOf("validation_results.messages[i].text")
    i := i + 1
ENDDO

oHttp:destroy()
oReq:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()