(PureBasic) Send SOAP 1.2 Request to Web Service Requiring Authentication

This example demonstrates sending a SOAP 1.2 request to a web service that requires both HTTP authentication in the Authorization request header, as well as a service-defined password in the XML body of the request.

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

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

    ; --------------------------------------------------------------------------------
    ; Also see Chilkat's Online WSDL Code Generator
    ; to generate code and SOAP Request and Response XML for each operation in a WSDL.
    ; --------------------------------------------------------------------------------

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

    ; We are sending the following POST:

    ; POST /wsSome_Testes/Service.asmx HTTP/1.1
    ; Host: www.something.com
    ; Content-Type: application/soap+xml; charset=utf-8
    ; Content-Length: length
    ; 
    ; <?xml version="1.0" encoding="utf-8"?>
    ; <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    ;   <soap12:Body>
    ;     <GetXYZbyABC xmlns="http://tempuri.org/">
    ;       <ABCBEN>string</ABCBEN>
    ;       <ABC>string</ABC>
    ;       <NumLocal>int</NumLocal>
    ;       <Password>string</Password>
    ;       <MsgErro>string</MsgErro>
    ;     </GetXYZbyABC>
    ;   </soap12:Body>
    ; </soap12:Envelope>
    ; 

    ; First, specify the login/password for the Authorization request header (not shown in the headers above).
    CkHttp::setCkLogin(http, "YOUR_LOGIN")
    ; The need for a login domain depends on the web service..
    CkHttp::setCkLoginDomain(http, "YOUR_DOMAIN")
    CkHttp::setCkPassword(http, "YOUR_PASSWORD")

    ; Build the SOAP XML shown above:
    ; Replace VAL_ABCBEN, VAL_ABC, VAL_NUMLOCAL, and YOUR_SOAP_BODY_PASSWORD with actual values..
    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::setCkTag(xml, "soap12:Envelope")
    CkXml::ckAddAttribute(xml,"xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance")
    CkXml::ckAddAttribute(xml,"xmlns:xsd","http://www.w3.org/2001/XMLSchema")
    CkXml::ckAddAttribute(xml,"xmlns:soap12","http://www.w3.org/2003/05/soap-envelope")
    CkXml::ckUpdateAttrAt(xml,"soap12:Body|GetXYZbyABC",1,"xmlns","http://tempuri.org/")
    CkXml::ckUpdateChildContent(xml,"soap12:Body|GetXYZbyABC|ABCBEN","VAL_ABCBEN")
    CkXml::ckUpdateChildContent(xml,"soap12:Body|GetXYZbyABC|ABC","VAL_ABC")
    CkXml::ckUpdateChildContent(xml,"soap12:Body|GetXYZbyABC|NumLocal","VAL_NUMLOCAL")
    CkXml::ckUpdateChildContent(xml,"soap12:Body|GetXYZbyABC|Password","YOUR_SOAP_BODY_PASSWORD")
    CkXml::ckUpdateChildContent(xml,"soap12:Body|GetXYZbyABC|MsgErro","x")

    ; Set the Content-Type of the request.
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/soap+xml")

    ; We don't need to specify the Content-Length or Host headers.  Chilkat automatically adds them.

    ; Send the request...
    resp.i = CkHttp::ckPostXml(http,"https://www.something.com/wsSome_Testes/Service.asmx",CkXml::ckGetXml(xml),"utf-8")
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(xml)
        ProcedureReturn
    EndIf

    Debug "Response Status Code = " + Str(CkHttpResponse::ckStatusCode(resp))

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

    CkXml::ckLoadXml(respXml,CkHttpResponse::ckBodyStr(resp))
    CkHttpResponse::ckDispose(resp)

    Debug "Response XML:"
    Debug CkXml::ckGetXml(respXml)

    ; The response XML should look like this:

    ; <?xml version="1.0" encoding="utf-8"?>
    ; <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    ;   <soap12:Body>
    ;     <GetXYZbyABCResponse xmlns="http://tempuri.org/">
    ;       <GetXYZbyABCResult>int</GetXYZbyABCResult>
    ;       <MsgErro>string</MsgErro>
    ;     </GetXYZbyABCResponse>
    ;   </soap12:Body>
    ; </soap12:Envelope>


    CkHttp::ckDispose(http)
    CkXml::ckDispose(xml)
    CkXml::ckDispose(respXml)


    ProcedureReturn
EndProcedure