Sample code for 30+ languages & platforms
Zig Requires Chilkat v11.0.0+

HTTP multipart-mixed POST (for a UPS Package Level Detail PLD Request)

See more HTTP Examples

Demonstrates how to create a POST for a UPS Package Level Detail PLD Request. The request must be a multipart-mixed request having two sub-parts. The first is a application/x-www-form-urlencoded with name=value URL encoded pairs. The second is a application/x-ups-binary containing a UPS PLD request.

The HTTP request created by this example looks like this:

POST /hapld/tos/kdwhapltos HTTP/1.1
Content-Type: multipart/mixed; boundary=------------050801040202040701030308
Host: domain
Content-Length: 658

--------------050801040202040701030308
Content-type: application/x-www-form-urlencoded
Content-length: 134

AppVersion=1.0&AcceptUPSLicenseAgreement=YES&VersionNumber=V4R1&UserId=myUser&Password=myPassword&ResponseType=application/x-ups-pld

--------------050801040202040701030308
Content-type: application/x-ups-binary
Content-length: 721

020094 2014041500000594196532600 000000001*AAV0Y203 DE 5941965326000001*BA1ZV0Y2036650001829 00001+0000000000000012 +0000000000000000KGS07COL10 3CMEUR000001*CA18TC239 AOK Bahnhofstr. Dresden 01099 DE *EAEVS+000000000000104200EUR*PA1ZV0Y2036650001829 02+0000012 +0000000+00000000+00000000+00000000*SA000005

--------------050801040202040701030308--

The HTTP response (if successful) is multipart MIME as shown below. This example will extract the response content using the Chilkat MIME API.
Content-type: text/html
Content-length: 138

<HTML>
<HEAD>
<TITLE>UPS Internet Software</TITLE>
</HEAD>
<BODY>
<P>UPS Internet Software, Copyright UPS 1998</P>
</BODY>
</HTML>

--BOUNDARY
Content-type: application/x-ups-psmpld
Content-length: 104

UPSOnLine%1.0%0000%0000Successful completion - No errors found.                                    

--BOUNDARY
Content-type: application/x-ups-pld
Content-length: 800

000200000787300000640 KDGPLCR1                   United Parcel Service                      09/06/16  Page:1                    Test PLD Control Report                     05:44 PM                                                                                  ------------------------------------------------------------------------------- Pickup Date:20030813 Sequence#:000005900000002 #of Segments:000000000000000005                                                                                                                                                                  Shipper#:0TEST0     Book/Page#:5900000002 Shipments:000001 Packages:0000000001 10000012900000000Successful completion - No errors found.                                        
!!! Test Upload !!!
File Uploaded: n/a

--BOUNDARY--

Chilkat Zig Downloads

Zig
const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

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

    const req = try chilkat.HttpRequest.init();
    defer req.deinit();

    // The ContentType, HttpVerb, and Path properties should
    // always be explicitly set.
    req.setHttpVerb("POST");
    req.setPath("/hapld/tos/kdwhapltos");
    req.setContentType("multipart/mixed");

    // The 1st body of the multipart/mixed HTTP request will have a content-type of application/x-www-form-urlencoded
    // It contains URL encoded parameters.
    // We'll use a temporary HTTP request object solely for the purpose of generating our URL encoded parameter string.
    const param_encoder = try chilkat.HttpRequest.init();
    defer param_encoder.deinit();
    param_encoder.addParam("AppVersion", "1.0");
    param_encoder.addParam("AcceptUPSLicenseAgreement", "YES");
    param_encoder.addParam("VersionNumber", "V4R1");
    param_encoder.addParam("UserId", "UPS_USERID");
    param_encoder.addParam("Password", "UPS_PASSWORD");
    const url_encoded_params = try param_encoder.getUrlEncodedParams(alloc);

    // The UPS server wants all params to be URL encoded except for the ResponseType param.
    // Therefore, we'll add ResponseType unencoded at the end, like this:
    const sb_params = try chilkat.StringBuilder.init();
    defer sb_params.deinit();
    sb_params.append(url_encoded_params) catch {};
    sb_params.append("&ResponseType=application/x-ups-pld") catch {};
    // Also, it is very important to include a CRLF at the end.  (This is to satisfy undocumented details
    // required by the UPS PLD server.)
    sb_params.append("\r\n") catch {};

    // Add the params as the 1st sub-part of the multipart/mixed request
    req.addStringForUpload2("", "", try sb_params.getAsString(alloc), "", "application/x-www-form-urlencoded") catch {};

    // Now for the 2nd part (using some junk data found on the developerkitcommunity.ups.com site.
    // Notice the CRLF at the end of the string.  This is important.
    const pld = "020094                                  2003081300000590000000200   000000001*AA0TEST0    DE                5900000002000001*BA1Z0TEST06800000018                 00001+0000000000000010 +0000000000000000KGS11PRE10                                   3CMEUR000001*CA18                                   United Parcel Service              Goerlitzer Str 1                                                                                         Neuss                              41460    DE                                                        *PA1Z0TEST06800000018                 02+0000010                                                                                      +0000000+00000000+00000000+00000000*SA000004\r\n";

    req.addStringForUpload2("", "", pld, "", "application/x-ups-binary") catch {};

    // The UPS PLD server requires Content-Length headers within the MIME sub-parts of the request.
    // If a Content-Length sub-header is added (with an arbitrary value, such as 0),
    // then Chilkat will compute the actual sub-part size and replace the value when the request is sent.
    req.addSubHeader(0, "Content-Length", "0") catch {};
    req.addSubHeader(1, "Content-Length", "0") catch {};

    // A few important comments about the HTTP request that is generated:
    //
    // 1) Chilkat automatically generates a random boundary string.   In 99.999% of cases, this should
    //    be sufficient.
    // 2) The top-level Content-Length header is automatically generated based on the actual length of the MIME message
    //    that follows the intial (topmost) MIME header.
    // 3) The HOST header will automatically get filled in with the actual domain when HttpSReq
    //    method is called.

    // Now send the request...
    const http = try chilkat.Http.init();
    defer http.deinit();

    // If desired (for debugging), provide a flie path for a session log.
    // The session log can be sent to support@chilkatsoft.com if the PLD request fails.
    http.setSessionLogFilename("c:/aaworkarea/ups_pld/sessionLog.txt");

    // Send the PLD request over TLS..
    const resp = try chilkat.HttpResponse.init();
    defer resp.deinit();
    http.httpSReq("www.pld-certify.ups.com", 443, true, req, resp) catch {
        std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
        return;
    };

    // Load the response MIME.
    const mime = try chilkat.Mime.init();
    defer mime.deinit();
    mime.loadMime(try resp.getFullMime(alloc)) catch {};

    // If it does not have 3 sub-parts, then something is amiss...
    if (mime.getNumParts() != 3) {
        std.debug.print("Unexpected number of MIME parts.\n", .{});
        std.debug.print("{s}\n", .{try resp.getFullMime(alloc)});
        return;
    }

    // Examine each response part.

    const part0 = try chilkat.Mime.init();
    defer part0.deinit();
    try mime.partAt(0, part0);

    std.debug.print("---- text/html part ----\n", .{});
    std.debug.print("{s}\n", .{try part0.getBodyDecoded(alloc)});

    const part1 = try chilkat.Mime.init();
    defer part1.deinit();
    try mime.partAt(1, part1);

    std.debug.print("---- application/x-ups-psmpld part ----\n", .{});
    std.debug.print("{s}\n", .{try part1.getBodyDecoded(alloc)});

    const part2 = try chilkat.Mime.init();
    defer part2.deinit();
    try mime.partAt(2, part2);

    std.debug.print("---- application/x-ups-pld part ----\n", .{});
    std.debug.print("{s}\n", .{try part2.getBodyDecoded(alloc)});
}