PureBasic

SOAP with MTOM XOP 8bit (binary) Attachment

See more HTTP Examples

Demonstrates how to send the following sample SOAP request with an MTOM/XOP attachment:

Content-Type: Multipart/Related; start-info="text/xml"; type="application/xop+xml"; boundary="----=_Part_0_1744155.1118953559416"
Content-Length: 3453
SOAPAction: "some-SOAP-action"

------=_Part_1_4558657.1118953559446
Content-Type: application/xop+xml; type="text/xml"; charset=utf-8

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Detail xmlns="http://example.org/mtom/data">
      <image>
        <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org" />
      </image>
    </Detail>
  </soap:Body>
</soap:Envelope>

------=_Part_1_4558657.1118953559446
Content-Type: image/jpeg
Content-ID: _LT_5aeaa450-17f0-4484-b845-a8480c363444@example.org_GT_
Content-Disposition: 8bit

... binary data ...

PureBasic

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    soapXml.i = CkXml::ckCreate()
    If soapXml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::setCkTag(soapXml, "soap:Envelope")
    success = CkXml::ckAddAttribute(soapXml,"xmlns:soap","http://schemas.xmlsoap.org/soap/envelope/")

    CkXml::ckNewChild2(soapXml,"soap:Body","")
    success = CkXml::ckGetChild2(soapXml,0)

    CkXml::ckNewChild2(soapXml,"Detail","")
    success = CkXml::ckGetChild2(soapXml,0)
    success = CkXml::ckAddAttribute(soapXml,"xmlns","http://example.org/mtom/data")

    CkXml::ckNewChild2(soapXml,"image","")
    success = CkXml::ckGetChild2(soapXml,0)

    CkXml::ckNewChild2(soapXml,"xop:Include","")
    success = CkXml::ckGetChild2(soapXml,0)
    success = CkXml::ckAddAttribute(soapXml,"xmlns:xop","http://www.w3.org/2004/08/xop/include")
    success = CkXml::ckAddAttribute(soapXml,"href","cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org")

    CkXml::ckGetRoot2(soapXml)
    CkXml::setCkEmitXmlDecl(soapXml, 0)

    xmlBody.s = CkXml::ckGetXml(soapXml)
    Debug xmlBody

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/something/someTarget")

    CkHttpRequest::setCkContentType(req, "multipart/related; start-info=" + Chr(34) + "text/xml" + Chr(34) + "; type=" + Chr(34) + "application/xop+xml" + Chr(34))
    CkHttpRequest::ckAddHeader(req,"SOAPAction","some-SOAP-action")

    success = CkHttpRequest::ckAddStringForUpload2(req,"","",xmlBody,"utf-8","application/xop+xml; type=" + Chr(34) + "text/xml" + Chr(34) + "; charset=utf-8")

    ; The bytes will be sent as binary (not base64 encoded).
    success = CkHttpRequest::ckAddFileForUpload2(req,"","qa_data/jpg/starfish.jpg","image/jpeg")

    ; The JPEG data is the 2nd sub-part, and therefore is at index 1 (the first sub-part is at index 0)
    success = CkHttpRequest::ckAddSubHeader(req,1,"Content-ID","<5aeaa450-17f0-4484-b845-a8480c363444@example.org>")

    ; Add the Content-Disposition: 8bit sub-header
    success = CkHttpRequest::ckAddSubHeader(req,1,"Content-Disposition","8bit")

    CkHttp::setCkFollowRedirects(http, 1)

    ; For debugging, set the SessionLogFilename property
    ; to see the exact HTTP request and response in a log file.
    ; (Given that the request contains binary data, you'll need an editor
    ; that can gracefully view text + binary data.  I use EmEditor for most simple editing tasks..)
    CkHttp::setCkSessionLogFilename(http, "qa_output/mtom_sessionLog.txt")

    useTls.i = 1
    ; Note: Please don't run this example without changing the domain to your own domain...
    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpSReq(http,"www.example.org",443,useTls,req,resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(soapXml)
        CkHttpRequest::ckDispose(req)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    xmlResponse.i = CkXml::ckCreate()
    If xmlResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkXml::ckLoadXml(xmlResponse,CkHttpResponse::ckBodyStr(resp))
    Debug CkXml::ckGetXml(xmlResponse)


    CkHttp::ckDispose(http)
    CkXml::ckDispose(soapXml)
    CkHttpRequest::ckDispose(req)
    CkHttpResponse::ckDispose(resp)
    CkXml::ckDispose(xmlResponse)


    ProcedureReturn
EndProcedure