Rust
Rust
UPS Tracking API
See more HTTP Misc Examples
Demonstrates making a call to the UPS tracking REST API. Parses the tracking response and extracts the base64 signature image to a gif file.Chilkat Rust Downloads
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = chilkat::Http::new();
// This is the testing endpoint for the tracking API:
let url = "https://wwwcie.ups.com/rest/Track".to_string();
// Send an HTTP request with the following JSON body:
// {
// "UPSSecurity": {
// "UsernameToken": {
// "Username": "Your Username",
// "Password": "Your Password"
// },
// "ServiceAccessToken": {
// "AccessLicenseNumber": "Your Access License Number"
// }
// },
// "TrackRequest": {
// "Request": {
// "RequestOption": "1",
// "TransactionReference": {
// "CustomerContext": "Your Test Case Summary Description"
// }
// },
// "InquiryNumber": "YourTrackingNumber"
// }
// }
//
// Build the above JSON.
let json = chilkat::JsonObject::new();
let _ = json.update_string("UPSSecurity.UsernameToken.Username", "UPS_USERNAME");
let _ = json.update_string("UPSSecurity.UsernameToken.Password", "UPS_PASSWORD");
let _ = json.update_string("UPSSecurity.ServiceAccessToken.AccessLicenseNumber", "UPS_ACCESS_KEY");
// Request all activity...
let _ = json.update_string("TrackRequest.Request.RequestOption", "activity");
let _ = json.update_string("TrackRequest.Request.TransactionReference.CustomerContext", "Your Test Case Summary Description");
let _ = json.update_string("TrackRequest.InquiryNumber", "1Z12345E0205271688");
let sb = chilkat::StringBuilder::new();
let resp = chilkat::HttpResponse::new();
if http.http_json("POST", &url, &json, "application/json", &resp).is_err() {
println!("{}", http.last_error_text());
return;
}
println!("status = {}", resp.status_code());
// A 200 response status indicate success.
if resp.status_code() != 200 {
println!("{}", resp.body_str());
println!("Failed.");
return;
}
let _ = json.load(&resp.body_str());
json.set_emit_compact(false);
println!("{}", json.emit().unwrap_or_default());
// {
// "TrackResponse": {
// "Response": {
// "ResponseStatus": {
// "Code": "1",
// "Description": "Success"
// },
// "TransactionReference": {
// "CustomerContext": "Your Test Case Summary Description"
// }
// },
// "Shipment": {
// "InquiryNumber": {
// "Code": "01",
// "Description": "ShipmentIdentificationNumber",
// "Value": "1Z12345E0205271688"
// },
// "ShipmentType": {
// "Code": "01",
// "Description": "Small Package"
// },
// "ShipperNumber": "12345E",
// "Service": {
// "Code": "002",
// "Description": "2ND DAY AIR"
// },
// "ReferenceNumber": {
// "Code": "01",
// "Value": "LINE4AND115"
// },
// "PickupDate": "19990608",
// "Package": {
// "TrackingNumber": "1Z12345E0205271688",
// "Activity": [
// {
// "ActivityLocation": {
// "Address": {
// "City": "ANYTOWN",
// "StateProvinceCode": "GA",
//
// "PostalCode": "30340",
// "CountryCode": "US"
// },
// "Code": "ML",
// "Description": "BACK DOOR",
// "SignedForByName": "JOHN DOE"
// },
// "Status": {
// "Type": "D",
// "Description": "DELIVERED",
// "Code": "KM"
// },
// "Date": "19990610",
// "Time": "120000",
// "Document": {
// "Type": {
// "Code": "01",
// "Description": "Signature Image"
// },
// "Content": "R0lGODdhoA ... JU9Y8RdHsRKLMVJ4MVDMREAAADs=",
// "Format": {
// "Code": "01",
// "Description": "GIF"
// }
// }
// },
// {
// "Status": {
// "Type": "M",
// "Description": "BILLING INFORMATION RECEIVED. SHIPMENT DATE PENDING.",
// "Code": "MP"
// },
// "Date": "19990608",
// "Time": "120000"
// }
// ],
// "PackageWeight": {
// "UnitOfMeasurement": {
// "Code": "LBS"
// },
// "Weight": "5.00"
// },
// "ReferenceNumber": [
// {
// "Code": "01",
// "Value": "LINE4AND115"
// },
// {
// "Code": "08",
// "Value": "LJ67Y5"
// }
// ]
// }
// },
// "Disclaimer": "You are using UPS tracking service on customer integration test environment, please switch to UPS production environment once you finish the test. The URL is https://onlinetools.ups.com/webservices/Track"
// }
// }
// Use the online tool at Generate JSON Parsing Code
// to generate JSON parsing code.
let status_code = json.string_of("TrackResponse.Response.ResponseStatus.Code").unwrap_or_default();
let status_description = json.string_of("TrackResponse.Response.ResponseStatus.Description").unwrap_or_default();
println!("statusCode: {}", status_code);
println!("statusDescription{}", status_description);
let customer_context = json.string_of("TrackResponse.Response.TransactionReference.CustomerContext").unwrap_or_default();
let inquiry_number_code = json.string_of("TrackResponse.Shipment.InquiryNumber.Code").unwrap_or_default();
let inquiry_number_description = json.string_of("TrackResponse.Shipment.InquiryNumber.Description").unwrap_or_default();
let inquiry_number_value = json.string_of("TrackResponse.Shipment.InquiryNumber.Value").unwrap_or_default();
let shipment_type_code = json.string_of("TrackResponse.Shipment.ShipmentType.Code").unwrap_or_default();
let shipment_type_description = json.string_of("TrackResponse.Shipment.ShipmentType.Description").unwrap_or_default();
let shipper_number = json.string_of("TrackResponse.Shipment.ShipperNumber").unwrap_or_default();
let service_code = json.string_of("TrackResponse.Shipment.Service.Code").unwrap_or_default();
let service_description = json.string_of("TrackResponse.Shipment.Service.Description").unwrap_or_default();
let reference_number_code = json.string_of("TrackResponse.Shipment.ReferenceNumber.Code").unwrap_or_default();
let reference_number_value = json.string_of("TrackResponse.Shipment.ReferenceNumber.Value").unwrap_or_default();
let pickup_date = json.string_of("TrackResponse.Shipment.PickupDate").unwrap_or_default();
let tracking_number = json.string_of("TrackResponse.Shipment.Package.TrackingNumber").unwrap_or_default();
let unit_of_measurement_code = json.string_of("TrackResponse.Shipment.Package.PackageWeight.UnitOfMeasurement.Code").unwrap_or_default();
let weight = json.string_of("TrackResponse.Shipment.Package.PackageWeight.Weight").unwrap_or_default();
let disclaimer = json.string_of("TrackResponse.Disclaimer").unwrap_or_default();
let mut i = 0;
let activity_count = json.size_of_array("TrackResponse.Shipment.Package.Activity");
println!("activityCount: {}", activity_count);
while i < activity_count {
println!("-- activity {}", i);
json.set_i(i);
if json.has_member("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City") {
let city = json.string_of("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City").unwrap_or_default();
println!("city: {}", city);
let province_code = json.string_of("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.StateProvinceCode").unwrap_or_default();
let postal_code = json.string_of("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.PostalCode").unwrap_or_default();
let country_code = json.string_of("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.CountryCode").unwrap_or_default();
}
let location_code = json.string_of("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Code").unwrap_or_default();
let location_description = json.string_of("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Description").unwrap_or_default();
let location_signed_for_by_name = json.string_of("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.SignedForByName").unwrap_or_default();
let activity_status_type = json.string_of("TrackResponse.Shipment.Package.Activity[i].Status.Type").unwrap_or_default();
println!("activityStatusType: {}", activity_status_type);
let activity_status_description = json.string_of("TrackResponse.Shipment.Package.Activity[i].Status.Description").unwrap_or_default();
println!("activityStatusDescription: {}", activity_status_description);
let activity_status_code = json.string_of("TrackResponse.Shipment.Package.Activity[i].Status.Code").unwrap_or_default();
println!("activityStatusCode: {}", activity_status_code);
let activity_date = json.string_of("TrackResponse.Shipment.Package.Activity[i].Date").unwrap_or_default();
let activity_time = json.string_of("TrackResponse.Shipment.Package.Activity[i].Time").unwrap_or_default();
if json.has_member("TrackResponse.Shipment.Package.Activity[i].Document") {
let type_code = json.int_of("TrackResponse.Shipment.Package.Activity[i].Document.Type.Code");
let type_description = json.string_of("TrackResponse.Shipment.Package.Activity[i].Document.Type.Description").unwrap_or_default();
let document_content = json.string_of("TrackResponse.Shipment.Package.Activity[i].Document.Content").unwrap_or_default();
let document_format_code = json.string_of("TrackResponse.Shipment.Package.Activity[i].Document.Format.Code").unwrap_or_default();
// Format description would be something like "GIF" for a signature image.
let document_format_description = json.string_of("TrackResponse.Shipment.Package.Activity[i].Document.Format.Description").unwrap_or_default();
// 01 - Signature Image
// 02 - Delivery Receipt
// 03 - Free Astray
// 04 - POD
if type_code == 1 {
// We have a signature image. Get the image data and save to a file.
let sb_image_path = chilkat::StringBuilder::new();
let _ = sb_image_path.append("qa_output/sig_");
let _ = sb_image_path.append(&tracking_number);
let _ = sb_image_path.append(".");
let _ = sb_image_path.append(&document_format_description);
let image_data = chilkat::BinData::new();
let _ = image_data.append_encoded(&document_content, "base64").is_ok();
// Write to "qa_output/sig_1Z12345E0205271688.GIF"
let _ = image_data.write_file(&sb_image_path.get_as_string().unwrap_or_default()).is_ok();
}
}
i = i + 1;
}
i = 0;
let refnum_count = json.size_of_array("TrackResponse.Shipment.Package.ReferenceNumber");
while i < refnum_count {
json.set_i(i);
let refnum_code = json.string_of("TrackResponse.Shipment.Package.ReferenceNumber[i].Code").unwrap_or_default();
let refnum_value = json.string_of("TrackResponse.Shipment.Package.ReferenceNumber[i].Value").unwrap_or_default();
i = i + 1;
}
println!("Success.");