(Java) UPS Address Validation (City, State, Zip)

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

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    boolean success;

    CkHttp http = new CkHttp();

    String url = "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.
    CkJsonObject json = new CkJsonObject();
    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");

    CkStringBuilder sb = new CkStringBuilder();
    CkHttpResponse resp = http.PostJson3(url,"application/json",json);
    if (http.get_LastMethodSuccess() != true) {
        System.out.println(http.lastErrorText());
        return;
        }

    System.out.println("status = " + resp.get_StatusCode());

    // A 200 response status indicate success.
    if (resp.get_StatusCode() != 200) {
        System.out.println(resp.bodyStr());
        System.out.println("Failed.");

        return;
        }

    json.Load(resp.bodyStr());
    json.put_EmitCompact(false);
    System.out.println(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.

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

    int numResults = json.SizeOfArray("AddressValidationResponse.AddressValidationResult");
    if (numResults < 0) {

        // 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");

        System.out.println("Exact match!");
        System.out.println("postal code: " + postalCodeLowEnd);

        }
    else {

        System.out.println("Non-Exact match.");

        customerContext = json.stringOf("AddressValidationResponse.Response.TransactionReference.CustomerContext");
        statusCode = json.stringOf("AddressValidationResponse.Response.ResponseStatusCode");
        statusDescription = json.stringOf("AddressValidationResponse.Response.ResponseStatusDescription");
        int i = 0;
        while (i < numResults) {
            json.put_I(i);
            rank = json.stringOf("AddressValidationResponse.AddressValidationResult[i].Rank");
            System.out.println("rank: " + rank);
            quality = json.stringOf("AddressValidationResponse.AddressValidationResult[i].Quality");
            addressCity = json.stringOf("AddressValidationResponse.AddressValidationResult[i].Address.City");
            System.out.println("addressCity: " + addressCity);
            addressStateProvinceCode = json.stringOf("AddressValidationResponse.AddressValidationResult[i].Address.StateProvinceCode");
            postalCodeLowEnd = json.stringOf("AddressValidationResponse.AddressValidationResult[i].PostalCodeLowEnd");
            System.out.println("postal code: " + postalCodeLowEnd);
            postalCodeHighEnd = json.stringOf("AddressValidationResponse.AddressValidationResult[i].PostalCodeHighEnd");
            i = i+1;
            }

        }
  }
}