Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Go Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Go) UPS Tracking API

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 Go Downloads

Go Package for Windows, MacOS, Linux, Alpine Linux, Solaris

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

    var success bool

    http := chilkat.NewHttp()

    // This is the testing endpoint for the tracking API:
    url := "https://wwwcie.ups.com/rest/Track"

    // 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.
    json := chilkat.NewJsonObject()
    json.UpdateString("UPSSecurity.UsernameToken.Username","UPS_USERNAME")
    json.UpdateString("UPSSecurity.UsernameToken.Password","UPS_PASSWORD")
    json.UpdateString("UPSSecurity.ServiceAccessToken.AccessLicenseNumber","UPS_ACCESS_KEY")
    // Request all activity...
    json.UpdateString("TrackRequest.Request.RequestOption","activity")
    json.UpdateString("TrackRequest.Request.TransactionReference.CustomerContext","Your Test Case Summary Description")
    json.UpdateString("TrackRequest.InquiryNumber","1Z12345E0205271688")

    sb := chilkat.NewStringBuilder()
    resp := http.PostJson3(url,"application/json",json)
    if http.LastMethodSuccess() != true {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        sb.DisposeStringBuilder()
        return
    }

    fmt.Println("status = ", resp.StatusCode())

    // A 200 response status indicate success.
    if resp.StatusCode() != 200 {
        fmt.Println(resp.BodyStr())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        json.DisposeJsonObject()
        sb.DisposeStringBuilder()
        return
    }

    json.Load(resp.BodyStr())
    json.SetEmitCompact(false)
    fmt.Println(*json.Emit())

    // {
    //   "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.

    statusCode := json.StringOf("TrackResponse.Response.ResponseStatus.Code")
    statusDescription := json.StringOf("TrackResponse.Response.ResponseStatus.Description")
    fmt.Println("statusCode: ", *statusCode)
    fmt.Println("statusDescription", *statusDescription)
    customerContext := json.StringOf("TrackResponse.Response.TransactionReference.CustomerContext")
    inquiryNumberCode := json.StringOf("TrackResponse.Shipment.InquiryNumber.Code")
    inquiryNumberDescription := json.StringOf("TrackResponse.Shipment.InquiryNumber.Description")
    inquiryNumberValue := json.StringOf("TrackResponse.Shipment.InquiryNumber.Value")
    shipmentTypeCode := json.StringOf("TrackResponse.Shipment.ShipmentType.Code")
    shipmentTypeDescription := json.StringOf("TrackResponse.Shipment.ShipmentType.Description")
    shipperNumber := json.StringOf("TrackResponse.Shipment.ShipperNumber")
    serviceCode := json.StringOf("TrackResponse.Shipment.Service.Code")
    serviceDescription := json.StringOf("TrackResponse.Shipment.Service.Description")
    referenceNumberCode := json.StringOf("TrackResponse.Shipment.ReferenceNumber.Code")
    referenceNumberValue := json.StringOf("TrackResponse.Shipment.ReferenceNumber.Value")
    pickupDate := json.StringOf("TrackResponse.Shipment.PickupDate")
    trackingNumber := json.StringOf("TrackResponse.Shipment.Package.TrackingNumber")
    unitOfMeasurementCode := json.StringOf("TrackResponse.Shipment.Package.PackageWeight.UnitOfMeasurement.Code")
    weight := json.StringOf("TrackResponse.Shipment.Package.PackageWeight.Weight")
    disclaimer := json.StringOf("TrackResponse.Disclaimer")

    i := 0
    activityCount := json.SizeOfArray("TrackResponse.Shipment.Package.Activity")
    fmt.Println("activityCount: ", activityCount)

    for i < activityCount {
        fmt.Println("-- activity ", i)
        json.SetI(i)
        if json.HasMember("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City") == true {
            city := json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City")
            fmt.Println("city: ", *city)
            provinceCode := json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.StateProvinceCode")
            postalCode := json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.PostalCode")
            countryCode := json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.CountryCode")
        }

        locationCode := json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Code")
        locationDescription := json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Description")
        locationSignedForByName := json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.SignedForByName")

        activityStatusType := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Type")
        fmt.Println("activityStatusType: ", *activityStatusType)
        activityStatusDescription := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Description")
        fmt.Println("activityStatusDescription: ", *activityStatusDescription)
        activityStatusCode := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Code")
        fmt.Println("activityStatusCode: ", *activityStatusCode)

        activityDate := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Date")
        activityTime := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Time")

        if json.HasMember("TrackResponse.Shipment.Package.Activity[i].Document") == true {
            typeCode := json.IntOf("TrackResponse.Shipment.Package.Activity[i].Document.Type.Code")
            typeDescription := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Type.Description")
            documentContent := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Content")
            documentFormatCode := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Format.Code")
            // Format description would be something like "GIF" for a signature image.
            documentFormatDescription := json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Format.Description")

            // 01 - Signature Image
            // 02 - Delivery Receipt
            // 03 - Free Astray
            // 04 - POD
            if typeCode == 1 {
                // We have a signature image.  Get the image data and save to a file.
                sbImagePath := chilkat.NewStringBuilder()
                sbImagePath.Append("qa_output/sig_")
                sbImagePath.Append(*trackingNumber)
                sbImagePath.Append(".")
                sbImagePath.Append(*documentFormatDescription)
                imageData := chilkat.NewBinData()
                success = imageData.AppendEncoded(*documentContent,"base64")
                // Write to "qa_output/sig_1Z12345E0205271688.GIF"
                success = imageData.WriteFile(*sbImagePath.GetAsString())
            }

        }

        i = i + 1
    }

    i = 0
    refnumCount := json.SizeOfArray("TrackResponse.Shipment.Package.ReferenceNumber")
    for i < refnumCount {
        json.SetI(i)
        refnumCode := json.StringOf("TrackResponse.Shipment.Package.ReferenceNumber[i].Code")
        refnumValue := json.StringOf("TrackResponse.Shipment.Package.ReferenceNumber[i].Value")
        i = i + 1
    }

    fmt.Println("Success.")

    resp.DisposeHttpResponse()

    http.DisposeHttp()
    json.DisposeJsonObject()
    sb.DisposeStringBuilder()
    sbImagePath.DisposeStringBuilder()
    imageData.DisposeBinData()

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.