B4X

UPS Address Validation (City, State, Zip)

See more HTTP Misc Examples

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

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("http")

'  This is the testing endpoint for address validation:
Dim url As String = "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.
Dim json As ChilkatJsonObject
json.Initialize
json.UpdateString("AccessRequest.AccessLicenseNumber", "UPS_ACCESS_KEY")
json.UpdateString("AccessRequest.UserId", "UPS_USERNAME")
json.UpdateString("AccessRequest.Password", "UPS_PASSWORD")
json.UpdateString("AddressValidationRequest.Request.TransactionReference.CustomerContext", "Your Customer Context")
json.UpdateString("AddressValidationRequest.Request.RequestAction", "AV")
json.UpdateString("AddressValidationRequest.Address.City", "ALPHARETTA")
'  We're making an intentional mistake here by passing CA instead of GA.
json.UpdateString("AddressValidationRequest.Address.StateProvinceCode", "CA")
json.UpdateString("AddressValidationRequest.Address.PostalCode", "30005")

Dim sb As ChilkatStringBuilder
sb.Initialize
Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", url, json, "application/json", resp)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Log("status = " & resp.StatusCode)

'  A 200 response status indicate success.
If resp.StatusCode <> 200 Then
    Log(resp.BodyStr)
    Log("Failed.")
    Return
End If


json.Load(resp.BodyStr)
json.EmitCompact = False
Log(json.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.

Dim customerContext As String
Dim statusCode As String
Dim statusDescription As String
Dim resultRank As String
Dim resultQuality As String
Dim city As String
Dim provinceCode As String
Dim postalCodeLowEnd As String
Dim postalCodeHighEnd As String
Dim rank As String
Dim quality As String
Dim addressCity As String
Dim addressStateProvinceCode As String

Dim numResults As Int = json.SizeOfArray("AddressValidationResponse.AddressValidationResult")
If numResults < 0 Then

    '  Here's parse code for the above JSON exact response:
    customerContext = json.StringOf("AddressValidationResponse.Response.TransactionReference.CustomerContext")
    statusCode = json.StringOf("AddressValidationResponse.Response.ResponseStatusCode")
    statusDescription = json.StringOf("AddressValidationResponse.Response.ResponseStatusDescription")
    resultRank = json.StringOf("AddressValidationResponse.AddressValidationResult.Rank")
    resultQuality = json.StringOf("AddressValidationResponse.AddressValidationResult.Quality")
    city = json.StringOf("AddressValidationResponse.AddressValidationResult.Address.City")
    provinceCode = json.StringOf("AddressValidationResponse.AddressValidationResult.Address.StateProvinceCode")
    postalCodeLowEnd = json.StringOf("AddressValidationResponse.AddressValidationResult.PostalCodeLowEnd")
    postalCodeHighEnd = json.StringOf("AddressValidationResponse.AddressValidationResult.PostalCodeHighEnd")

    Log("Exact match!")
    Log("postal code: " & postalCodeLowEnd)

Else

    Log("Non-Exact match.")

    customerContext = json.StringOf("AddressValidationResponse.Response.TransactionReference.CustomerContext")
    statusCode = json.StringOf("AddressValidationResponse.Response.ResponseStatusCode")
    statusDescription = json.StringOf("AddressValidationResponse.Response.ResponseStatusDescription")
    Dim i As Int = 0
    Do While i < numResults
        json.I = i
        rank = json.StringOf("AddressValidationResponse.AddressValidationResult[i].Rank")
        Log("rank: " & rank)
        quality = json.StringOf("AddressValidationResponse.AddressValidationResult[i].Quality")
        addressCity = json.StringOf("AddressValidationResponse.AddressValidationResult[i].Address.City")
        Log("addressCity: " & addressCity)
        addressStateProvinceCode = json.StringOf("AddressValidationResponse.AddressValidationResult[i].Address.StateProvinceCode")
        postalCodeLowEnd = json.StringOf("AddressValidationResponse.AddressValidationResult[i].PostalCodeLowEnd")
        Log("postal code: " & postalCodeLowEnd)
        postalCodeHighEnd = json.StringOf("AddressValidationResponse.AddressValidationResult[i].PostalCodeHighEnd")
        i = i + 1
    Loop
End If