(Delphi ActiveX) UPS Address Validation (City, State, Zip)

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

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
http: TChilkatHttp;
url: WideString;
json: TChilkatJsonObject;
sb: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
customerContext: WideString;
statusCode: WideString;
statusDescription: WideString;
resultRank: WideString;
resultQuality: WideString;
city: WideString;
provinceCode: WideString;
postalCodeLowEnd: WideString;
postalCodeHighEnd: WideString;
rank: WideString;
quality: WideString;
addressCity: WideString;
addressStateProvinceCode: WideString;
numResults: Integer;
i: Integer;

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

http := TChilkatHttp.Create(Self);

// This is the testing endpoint for address validation:
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.
json := TChilkatJsonObject.Create(Self);
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');

sb := TChilkatStringBuilder.Create(Self);
resp := http.PostJson3(url,'application/json',json.ControlInterface);
if (http.LastMethodSuccess <> 1) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add('status = ' + IntToStr(resp.StatusCode));

// A 200 response status indicate success.
if (resp.StatusCode <> 200) then
  begin
    Memo1.Lines.Add(resp.BodyStr);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

json.Load(resp.BodyStr);
json.EmitCompact := 0;
Memo1.Lines.Add(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.

numResults := json.SizeOfArray('AddressValidationResponse.AddressValidationResult');
if (numResults < 0) then
  begin

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

    Memo1.Lines.Add('Exact match!');
    Memo1.Lines.Add('postal code: ' + postalCodeLowEnd);

  end
else
  begin

    Memo1.Lines.Add('Non-Exact match.');

    customerContext := json.StringOf('AddressValidationResponse.Response.TransactionReference.CustomerContext');
    statusCode := json.StringOf('AddressValidationResponse.Response.ResponseStatusCode');
    statusDescription := json.StringOf('AddressValidationResponse.Response.ResponseStatusDescription');
    i := 0;
    while i < numResults do
      begin
        json.I := i;
        rank := json.StringOf('AddressValidationResponse.AddressValidationResult[i].Rank');
        Memo1.Lines.Add('rank: ' + rank);
        quality := json.StringOf('AddressValidationResponse.AddressValidationResult[i].Quality');
        addressCity := json.StringOf('AddressValidationResponse.AddressValidationResult[i].Address.City');
        Memo1.Lines.Add('addressCity: ' + addressCity);
        addressStateProvinceCode := json.StringOf('AddressValidationResponse.AddressValidationResult[i].Address.StateProvinceCode');
        postalCodeLowEnd := json.StringOf('AddressValidationResponse.AddressValidationResult[i].PostalCodeLowEnd');
        Memo1.Lines.Add('postal code: ' + postalCodeLowEnd);
        postalCodeHighEnd := json.StringOf('AddressValidationResponse.AddressValidationResult[i].PostalCodeHighEnd');
        i := i + 1;
      end;

  end;
end;