Sample code for 30+ languages & platforms
Xbase++

UPS Address Validation (City, State, Zip)

See more HTTP Misc Examples

Demonstrates making a call to the UPS address validation REST API.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++
Xbase++ 
LOCAL nSuccess
LOCAL oHttp
LOCAL cUrl
LOCAL oJson
LOCAL oSb
LOCAL oResp
LOCAL cCustomerContext
LOCAL cStatusCode
LOCAL cStatusDescription
LOCAL cResultRank
LOCAL cResultQuality
LOCAL cCity
LOCAL cProvinceCode
LOCAL cPostalCodeLowEnd
LOCAL cPostalCodeHighEnd
LOCAL cRank
LOCAL cQuality
LOCAL cAddressCity
LOCAL cAddressStateProvinceCode
LOCAL nNumResults
LOCAL i

nSuccess := 0

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

oHttp := CreateObject("Chilkat.Http")

//  This is the testing endpoint for address validation:
cUrl := "https://wwwcie.ups.com/rest/AV"

//  Send an HTTP request with the following JSON body:

//  {
//    "AccessRequest": {
//      "AccessLicenseNumber": "Your Access License Number",
//      "UserId": "Your Username",
//      "Password": "Your Password"
//    },
//    "AddressValidationRequest": {
//      "Request": {
//        "TransactionReference": {
//          "CustomerContext": "Your Customer Context"
//        },
//        "RequestAction": "AV"
//      },
//      "Address": {
//        "City": "ALPHARETTA",
//        "StateProvinceCode": "GA",
//        "PostalCode": "30005"
//      }
//    }
//  }

//  Build the above JSON.
oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("AccessRequest.AccessLicenseNumber", "UPS_ACCESS_KEY")
oJson:UpdateString("AccessRequest.UserId", "UPS_USERNAME")
oJson:UpdateString("AccessRequest.Password", "UPS_PASSWORD")
oJson:UpdateString("AddressValidationRequest.Request.TransactionReference.CustomerContext", "Your Customer Context")
oJson:UpdateString("AddressValidationRequest.Request.RequestAction", "AV")
oJson:UpdateString("AddressValidationRequest.Address.City", "ALPHARETTA")
//  We're making an intentional mistake here by passing CA instead of GA.
oJson:UpdateString("AddressValidationRequest.Address.StateProvinceCode", "CA")
oJson:UpdateString("AddressValidationRequest.Address.PostalCode", "30005")

oSb := CreateObject("Chilkat.StringBuilder")
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpJson("POST", cUrl, oJson, "application/json", oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oJson:destroy()
    oSb:destroy()
    oResp:destroy()
    RETURN
ENDIF

? "status = " + Str(oResp:StatusCode)

//  A 200 response status indicate success.
IF (oResp:StatusCode != 200)
    ? oResp:BodyStr
    ? "Failed."
    oHttp:destroy()
    oJson:destroy()
    oSb:destroy()
    oResp:destroy()
    RETURN
ENDIF

oJson:Load(oResp:BodyStr)
oJson:EmitCompact := 0
? oJson:Emit()

//  A successful exact response looks like this:

//  {
//    "AddressValidationResponse": {
//      "Response": {
//        "TransactionReference": {
//          "CustomerContext": "Your Customer Context"
//        },
//        "ResponseStatusCode": "1",
//        "ResponseStatusDescription": "Success"
//      },
//      "AddressValidationResult": {
//        "Rank": "1",
//        "Quality": "1.0",
//        "Address": {
//          "City": "ALPHARETTA",
//          "StateProvinceCode": "GA"
//        },
//        "PostalCodeLowEnd": "30005",
//        "PostalCodeHighEnd": "30005"
//      }
//    }
//  }
//  

//  A successful response that was not an exact match provides an array of closest matches, like this:

//  {
//    "AddressValidationResponse": {
//      "Response": {
//        "TransactionReference": {
//          "CustomerContext": "Your Customer Context"
//          "Quality": "0.9875",
//          "Address": {
//        },
//        "ResponseStatusCode": "1",
//        "ResponseStatusDescription": "Success"
//      },
//      "AddressValidationResult": [
//        {
//          "Rank": "1",
//            "City": "ALPHARETTA",
//            "StateProvinceCode": "GA"
//          },
//          "PostalCodeLowEnd": "30005",
//          "PostalCodeHighEnd": "30005"
//        },
//        {
//          "Rank": "2",
//          "Quality": "0.9750",
//          "Address": {
//            "City": "ALPHARETTA",
//            "StateProvinceCode": "GA"
//          },
//          "PostalCodeLowEnd": "30004",
//          "PostalCodeHighEnd": "30004"
//        },
//        {
//          "Rank": "3",
//          "Quality": "0.9750",
//          "Address": {
//            "City": "ALPHARETTA",
//            "StateProvinceCode": "GA"
//          },
//          "PostalCodeLowEnd": "30009",
//          "PostalCodeHighEnd": "30009"
//        }
//      ]
//    }
//  }

//  Use the online tool at Generate JSON Parsing Code
//  to generate JSON parsing code.

nNumResults := oJson:SizeOfArray("AddressValidationResponse.AddressValidationResult")
IF (nNumResults < 0)

    //  Here's parse code for the above JSON exact response:
    cCustomerContext := oJson:StringOf("AddressValidationResponse.Response.TransactionReference.CustomerContext")
    cStatusCode := oJson:StringOf("AddressValidationResponse.Response.ResponseStatusCode")
    cStatusDescription := oJson:StringOf("AddressValidationResponse.Response.ResponseStatusDescription")
    cResultRank := oJson:StringOf("AddressValidationResponse.AddressValidationResult.Rank")
    cResultQuality := oJson:StringOf("AddressValidationResponse.AddressValidationResult.Quality")
    cCity := oJson:StringOf("AddressValidationResponse.AddressValidationResult.Address.City")
    cProvinceCode := oJson:StringOf("AddressValidationResponse.AddressValidationResult.Address.StateProvinceCode")
    cPostalCodeLowEnd := oJson:StringOf("AddressValidationResponse.AddressValidationResult.PostalCodeLowEnd")
    cPostalCodeHighEnd := oJson:StringOf("AddressValidationResponse.AddressValidationResult.PostalCodeHighEnd")

    ? "Exact match!"
    ? "postal code: " + cPostalCodeLowEnd

ELSE

    ? "Non-Exact match."

    cCustomerContext := oJson:StringOf("AddressValidationResponse.Response.TransactionReference.CustomerContext")
    cStatusCode := oJson:StringOf("AddressValidationResponse.Response.ResponseStatusCode")
    cStatusDescription := oJson:StringOf("AddressValidationResponse.Response.ResponseStatusDescription")
    i := 0
    DO WHILE i < nNumResults
        oJson:I := i
        cRank := oJson:StringOf("AddressValidationResponse.AddressValidationResult[i].Rank")
        ? "rank: " + cRank
        cQuality := oJson:StringOf("AddressValidationResponse.AddressValidationResult[i].Quality")
        cAddressCity := oJson:StringOf("AddressValidationResponse.AddressValidationResult[i].Address.City")
        ? "addressCity: " + cAddressCity
        cAddressStateProvinceCode := oJson:StringOf("AddressValidationResponse.AddressValidationResult[i].Address.StateProvinceCode")
        cPostalCodeLowEnd := oJson:StringOf("AddressValidationResponse.AddressValidationResult[i].PostalCodeLowEnd")
        ? "postal code: " + cPostalCodeLowEnd
        cPostalCodeHighEnd := oJson:StringOf("AddressValidationResponse.AddressValidationResult[i].PostalCodeHighEnd")
        i := i + 1
    ENDDO
ENDIF

oHttp:destroy()
oJson:destroy()
oSb:destroy()
oResp:destroy()