SpringCMServiceSoap / DocumentMerge

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:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
    CkXml::ckAddAttribute(xml,"xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header","")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentMerge|spr:token","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentMerge|spr:documentIds|spr:string","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://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
    soapAction.s = "http://www.springcm.com/atlas/webservices/v201308/scm/DocumentMerge"
    ;  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).

    MergeId.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentMergeResponse|*:DocumentMergeResult|*:MergeId")
    IsReady.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentMergeResponse|*:DocumentMergeResult|*:IsReady")
    MaxIndex.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentMergeResponse|*:DocumentMergeResult|*:MaxIndex")
    DocumentId.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentMergeResponse|*:DocumentMergeResult|*:Warnings|*:DocumentMergeWarning|*:DocumentId")
    Reason.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentMergeResponse|*:DocumentMergeResult|*:Warnings|*:DocumentMergeWarning|*:Reason")
    StoppedProcessing.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentMergeResponse|*:DocumentMergeResult|*:StoppedProcessing")
    StopReason.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentMergeResponse|*:DocumentMergeResult|*:StopReason")


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


    ProcedureReturn
EndProcedure

Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:spr="http://www.springcm.com/atlas/webservices/v201308/scm/">
    <soapenv:Header/>
    <soapenv:Body>
        <spr:DocumentMerge>
            <spr:token>string</spr:token>
            <spr:documentIds>
                <spr:string>string</spr:string>
            </spr:documentIds>
        </spr:DocumentMerge>
    </soapenv:Body>
</soapenv:Envelope>

Response XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:spr="http://www.springcm.com/atlas/webservices/v201308/scm/">
    <soapenv:Header/>
    <soapenv:Body>
        <spr:DocumentMergeResponse>
            <spr:DocumentMergeResult>
                <spr:MergeId>string</spr:MergeId>
                <spr:IsReady>true</spr:IsReady>
                <spr:MaxIndex>1042</spr:MaxIndex>
                <spr:Warnings>
                    <spr:DocumentMergeWarning>
                        <spr:DocumentId>string</spr:DocumentId>
                        <spr:Reason>NoPDF</spr:Reason>
                    </spr:DocumentMergeWarning>
                </spr:Warnings>
                <spr:StoppedProcessing>true</spr:StoppedProcessing>
                <spr:StopReason>NoDocument</spr:StopReason>
            </spr:DocumentMergeResult>
        </spr:DocumentMergeResponse>
    </soapenv:Body>
</soapenv:Envelope>