Chilkat Tools

SpringCMServiceSoap12 / DocumentMergeCheck

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

Min Request Full Request

load ./chilkat.dll

set xml [new_CkXml]

CkXml_put_Tag $xml "soap:Envelope"
CkXml_AddAttribute $xml "xmlns:soap" "http://www.w3.org/2003/05/soap-envelope"
CkXml_AddAttribute $xml "xmlns:spr" "http://www.springcm.com/atlas/webservices/v201308/scm/"
CkXml_UpdateChildContent $xml "soap:Header" ""
CkXml_UpdateChildContent $xml "soap:Body|spr:DocumentMergeCheck|spr:token" "string"
CkXml_UpdateChildContent $xml "soap:Body|spr:DocumentMergeCheck|spr:merges|spr:DocumentMergeResult|spr:MergeId" "string"
CkXml_UpdateChildContent $xml "soap:Body|spr:DocumentMergeCheck|spr:merges|spr:DocumentMergeResult|spr:IsReady" "true"
CkXml_UpdateChildContentInt $xml "soap:Body|spr:DocumentMergeCheck|spr:merges|spr:DocumentMergeResult|spr:MaxIndex" 1042
CkXml_UpdateChildContent $xml "soap:Body|spr:DocumentMergeCheck|spr:merges|spr:DocumentMergeResult|spr:Warnings|spr:DocumentMergeWarning|spr:DocumentId" "string"
CkXml_UpdateChildContent $xml "soap:Body|spr:DocumentMergeCheck|spr:merges|spr:DocumentMergeResult|spr:Warnings|spr:DocumentMergeWarning|spr:Reason" "NoPDF"
CkXml_UpdateChildContent $xml "soap:Body|spr:DocumentMergeCheck|spr:merges|spr:DocumentMergeResult|spr:StoppedProcessing" "true"
CkXml_UpdateChildContent $xml "soap:Body|spr:DocumentMergeCheck|spr:merges|spr:DocumentMergeResult|spr:StopReason" "NoDocument"

# 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_put_EmitXmlDecl $xml 0
set soapRequestBody [CkXml_getXml $xml]

set endpoint "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
set soapAction "http://www.springcm.com/atlas/webservices/v201308/scm/DocumentMergeCheck"
#  For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
set contentType "text/xml"

set http [new_CkHttp]

CkHttp_ClearHeaders $http
CkHttp_SetRequestHeader $http "Content-Type" $contentType
CkHttp_SetRequestHeader $http "SOAPAction" $soapAction

# resp is a CkHttpResponse
set resp [CkHttp_PostXml $http $endpoint $soapRequestBody "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    puts "Failed to send SOAP request."
    delete_CkXml $xml
    delete_CkHttp $http
    exit
}

# Get the XML response body.
set responseXml [new_CkXml]

CkHttpResponse_GetBodyXml $resp $responseXml

set statusCode [CkHttpResponse_get_StatusCode $resp]
puts "response status code: $statusCode"

delete_CkHttpResponse $resp

# If the status code does not indicate succcess, then show the response XML,
# which probably contains error information.
if {$statusCode != 200} then {
    puts [CkXml_getXml $responseXml]
    delete_CkXml $xml
    delete_CkHttp $http
    delete_CkXml $responseXml
    exit
}

puts [CkXml_getXml $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).

set MergeId [CkXml_getChildContent $responseXml "*:Body|*:DocumentMergeCheckResponse|*:DocumentMergeCheckResult|*:DocumentMergeResult|*:MergeId"]
set IsReady [CkXml_getChildContent $responseXml "*:Body|*:DocumentMergeCheckResponse|*:DocumentMergeCheckResult|*:DocumentMergeResult|*:IsReady"]
set MaxIndex [CkXml_GetChildIntValue $responseXml "*:Body|*:DocumentMergeCheckResponse|*:DocumentMergeCheckResult|*:DocumentMergeResult|*:MaxIndex"]
set DocumentId [CkXml_getChildContent $responseXml "*:Body|*:DocumentMergeCheckResponse|*:DocumentMergeCheckResult|*:DocumentMergeResult|*:Warnings|*:DocumentMergeWarning|*:DocumentId"]
set Reason [CkXml_getChildContent $responseXml "*:Body|*:DocumentMergeCheckResponse|*:DocumentMergeCheckResult|*:DocumentMergeResult|*:Warnings|*:DocumentMergeWarning|*:Reason"]
set StoppedProcessing [CkXml_getChildContent $responseXml "*:Body|*:DocumentMergeCheckResponse|*:DocumentMergeCheckResult|*:DocumentMergeResult|*:StoppedProcessing"]
set StopReason [CkXml_getChildContent $responseXml "*:Body|*:DocumentMergeCheckResponse|*:DocumentMergeCheckResult|*:DocumentMergeResult|*:StopReason"]

delete_CkXml $xml
delete_CkHttp $http
delete_CkXml $responseXml

Request XML

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:spr="http://www.springcm.com/atlas/webservices/v201308/scm/">
    <soap:Header/>
    <soap:Body>
        <spr:DocumentMergeCheck>
            <spr:token>string</spr:token>
            <spr:merges>
                <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:merges>
        </spr:DocumentMergeCheck>
    </soap:Body>
</soap:Envelope>

Response XML

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:spr="http://www.springcm.com/atlas/webservices/v201308/scm/">
    <soap:Header/>
    <soap:Body>
        <spr:DocumentMergeCheckResponse>
            <spr:DocumentMergeCheckResult>
                <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:DocumentMergeCheckResult>
        </spr:DocumentMergeCheckResponse>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentMergeCheck

Request XML

Response XML