ShipServiceSoapBinding / CancelShipment

ASP AutoIt C C (Unicode) C++ C++ (Unicode) C# DataFlex Delphi Foxpro Go Java Node.js Objective-C Perl PHP Extension PowerBuilder Powershell PureBasic Python CkPython Ruby SQL Server Swift TCL VB.NET VB6 VBScript Xojo

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

Procedure ChilkatExample()

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

    CkXml::setCkTag(xml, "soapenv:Envelope")
    CkXml::ckAddAttribute(xml,"xmlns:ns","http://www.parcelforce.net/ws/ship/v14")
    CkXml::ckAddAttribute(xml,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header","")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|ns:CancelShipmentRequest|ns:Authentication|ns:UserName","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|ns:CancelShipmentRequest|ns:Authentication|ns:Password","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|ns:CancelShipmentRequest|ns:ShipmentNumber","string")

    ; In a SOAP HTTP request, including the XML declaration (<?xml version="1.0" encoding="UTF-8"?>) in the XML body is generally not required. 
    CkXml::setCkEmitXmlDecl(xml, 0)
    soapRequestBody.s = CkXml::ckGetXml(xml)

    endpoint.s = "https://expresslink-uat1.neopost-id.com/ws/"
    soapAction.s = "CancelShipment"
    ;  For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
    contentType.s = "text/xml"

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

    CkHttp::ckClearHeaders(http)
    CkHttp::ckSetRequestHeader(http,"Content-Type",contentType)
    CkHttp::ckSetRequestHeader(http,"SOAPAction",soapAction)

    resp.i = CkHttp::ckPostXml(http,endpoint,soapRequestBody,"utf-8")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        Debug "Failed to send SOAP request."
        CkXml::ckDispose(xml)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    ; Get the XML response body.
    responseXml.i = CkXml::ckCreate()
    If responseXml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodyXml(resp,responseXml)

    statusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "response status code: " + Str(statusCode)

    CkHttpResponse::ckDispose(resp)

    ; If the status code does not indicate succcess, then show the response XML,
    ; which probably contains error information.
    If statusCode <> 200
        Debug CkXml::ckGetXml(responseXml)
        CkXml::ckDispose(xml)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(responseXml)
        ProcedureReturn
    EndIf

    Debug CkXml::ckGetXml(responseXml)

    ; Parse the successful SOAP response XML.

    ; This is a sample of the response XML, but the namespace prefixes will be different.
    ; We can parse the result using "*" for the namespace prefixes (see below).

    Code.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:CancelShipmentReply|*:Alerts|*:Alert|*:Code")
    Message.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:CancelShipmentReply|*:Alerts|*:Alert|*:Message")
    v_Type.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:CancelShipmentReply|*:Alerts|*:Alert|*:Type")
    Status.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:CancelShipmentReply|*:CompletedCancel|*:CompletedCancelInfo|*:Status")
    ShipmentNumber.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:CancelShipmentReply|*:CompletedCancel|*:CompletedCancelInfo|*:ShipmentNumber")


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


    ProcedureReturn
EndProcedure

Request XML

<soapenv:Envelope xmlns:ns="http://www.parcelforce.net/ws/ship/v14" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header/>
    <soapenv:Body>
        <ns:CancelShipmentRequest>
            <ns:Authentication>
                <ns:UserName>string</ns:UserName>
                <ns:Password>string</ns:Password>
            </ns:Authentication>
            <ns:ShipmentNumber>string</ns:ShipmentNumber>
        </ns:CancelShipmentRequest>
    </soapenv:Body>
</soapenv:Envelope>

Response XML

<soapenv:Envelope xmlns:ns="http://www.parcelforce.net/ws/ship/v14" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header/>
    <soapenv:Body>
        <ns:CancelShipmentReply>
            <ns:Alerts>
                <ns:Alert>
                    <ns:Code>123</ns:Code>
                    <ns:Message>string</ns:Message>
                    <ns:Type>ERROR</ns:Type>
                </ns:Alert>
            </ns:Alerts>
            <ns:CompletedCancel>
                <ns:CompletedCancelInfo>
                    <ns:Status>string</ns:Status>
                    <ns:ShipmentNumber>string</ns:ShipmentNumber>
                </ns:CompletedCancelInfo>
            </ns:CompletedCancel>
        </ns:CancelShipmentReply>
    </soapenv:Body>
</soapenv:Envelope>