Chilkat Tools

SpringCMServiceSoap12 / DocumentXMLMerge

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

import sys
import chilkat2

xml = chilkat2.Xml()
xml.Tag = "soap:Envelope"
xml.AddAttribute("xmlns:soap","http://www.w3.org/2003/05/soap-envelope")
xml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
xml.UpdateChildContent("soap:Header","")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:token","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Id","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Name","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:ObjectType","Document")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:ParentFolderId","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:CreatedBy","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:CreatedDate","dateTime")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:UpdatedBy","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:UpdatedDate","dateTime")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Security","list of enumerated string values")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Description","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:GroupName","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:FieldName","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:Value","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:HighValue","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:SetName","string")
xml.UpdateChildContentInt("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042)
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:DataType","String")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:CheckedOutUserId","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:CheckedOutUserName","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:ExpirationDate","dateTime")
xml.UpdateChildContentInt("soap:Body|spr:DocumentXMLMerge|spr:template|spr:FileSize",123456)
xml.UpdateChildContentInt("soap:Body|spr:DocumentXMLMerge|spr:template|spr:PDFFileSize",123456)
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:PDFConversion","true")
xml.UpdateChildContentInt("soap:Body|spr:DocumentXMLMerge|spr:template|spr:PDFPageCount",1042)
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:IsFormDocument","true")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:CustomFormFields|spr:SCMFormField|spr:Key","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:CustomFormFields|spr:SCMFormField|spr:Value","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:CustomFormFields|spr:SCMFormField|spr:SetName","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:MIMEType","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:template|spr:Version","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:SourceType","Document")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:Id","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:Name","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:ObjectType","Document")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:ParentFolderId","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:CreatedBy","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:CreatedDate","dateTime")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:UpdatedBy","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:UpdatedDate","dateTime")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:Security","list of enumerated string values")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:Description","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:dataSource|spr:String","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Id","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Name","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:ObjectType","Document")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:ParentFolderId","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:CreatedBy","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:CreatedDate","dateTime")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:UpdatedBy","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:UpdatedDate","dateTime")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Security","list of enumerated string values")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Description","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:GroupName","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:FieldName","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:Value","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:HighValue","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:SetName","string")
xml.UpdateChildContentInt("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042)
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:DataType","String")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destination|spr:LimitAttributeGroups|spr:string","string")
xml.UpdateChildContent("soap:Body|spr:DocumentXMLMerge|spr:destinationName","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. 
xml.EmitXmlDecl = False
soapRequestBody = xml.GetXml()

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

http = chilkat2.Http()

http.ClearHeaders()
http.SetRequestHeader("Content-Type",contentType)
http.SetRequestHeader("SOAPAction",soapAction)

# resp is a CkHttpResponse
resp = http.PostXml(endpoint,soapRequestBody,"utf-8")
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    print("Failed to send SOAP request.")
    sys.exit()

# Get the XML response body.
responseXml = chilkat2.Xml()
resp.GetBodyXml(responseXml)

statusCode = resp.StatusCode
print("response status code: " + str(statusCode))

# If the status code does not indicate succcess, then show the response XML,
# which probably contains error information.
if (statusCode != 200):
    print(responseXml.GetXml())
    sys.exit()

print(responseXml.GetXml())

# 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).

DocumentXMLMergeResult = responseXml.GetChildContent("*:Body|*:DocumentXMLMergeResponse|*:DocumentXMLMergeResult")

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:DocumentXMLMerge>
            <spr:token>string</spr:token>
            <spr:template>
                <spr:Id>string</spr:Id>
                <spr:Name>string</spr:Name>
                <spr:ObjectType>Document</spr:ObjectType>
                <spr:ParentFolderId>string</spr:ParentFolderId>
                <spr:CreatedBy>string</spr:CreatedBy>
                <spr:CreatedDate>dateTime</spr:CreatedDate>
                <spr:UpdatedBy>string</spr:UpdatedBy>
                <spr:UpdatedDate>dateTime</spr:UpdatedDate>
                <spr:Security>list of enumerated string values</spr:Security>
                <spr:Description>string</spr:Description>
                <spr:Metadata>
                    <spr:SCMMetadata>
                        <spr:GroupName>string</spr:GroupName>
                        <spr:FieldName>string</spr:FieldName>
                        <spr:Value>string</spr:Value>
                        <spr:HighValue>string</spr:HighValue>
                        <spr:ExcludeFromSearch>true</spr:ExcludeFromSearch>
                        <spr:SetName>string</spr:SetName>
                        <spr:SetNumber>1042</spr:SetNumber>
                        <spr:DataType>String</spr:DataType>
                    </spr:SCMMetadata>
                </spr:Metadata>
                <spr:CheckedOutUserId>string</spr:CheckedOutUserId>
                <spr:CheckedOutUserName>string</spr:CheckedOutUserName>
                <spr:ExpirationDate>dateTime</spr:ExpirationDate>
                <spr:FileSize>123456</spr:FileSize>
                <spr:PDFFileSize>123456</spr:PDFFileSize>
                <spr:PDFConversion>true</spr:PDFConversion>
                <spr:PDFPageCount>1042</spr:PDFPageCount>
                <spr:IsFormDocument>true</spr:IsFormDocument>
                <spr:CustomFormFields>
                    <spr:SCMFormField>
                        <spr:Key>string</spr:Key>
                        <spr:Value>string</spr:Value>
                        <spr:SetName>string</spr:SetName>
                        <spr:SetNumber>string</spr:SetNumber>
                    </spr:SCMFormField>
                </spr:CustomFormFields>
                <spr:MIMEType>string</spr:MIMEType>
                <spr:Version>string</spr:Version>
            </spr:template>
            <spr:dataSource>
                <spr:SourceType>Document</spr:SourceType>
                <spr:Object>
                    <spr:Id>string</spr:Id>
                    <spr:Name>string</spr:Name>
                    <spr:ObjectType>Document</spr:ObjectType>
                    <spr:ParentFolderId>string</spr:ParentFolderId>
                    <spr:CreatedBy>string</spr:CreatedBy>
                    <spr:CreatedDate>dateTime</spr:CreatedDate>
                    <spr:UpdatedBy>string</spr:UpdatedBy>
                    <spr:UpdatedDate>dateTime</spr:UpdatedDate>
                    <spr:Security>list of enumerated string values</spr:Security>
                    <spr:Description>string</spr:Description>
                </spr:Object>
                <spr:String>string</spr:String>
            </spr:dataSource>
            <spr:destination>
                <spr:Id>string</spr:Id>
                <spr:Name>string</spr:Name>
                <spr:ObjectType>Document</spr:ObjectType>
                <spr:ParentFolderId>string</spr:ParentFolderId>
                <spr:CreatedBy>string</spr:CreatedBy>
                <spr:CreatedDate>dateTime</spr:CreatedDate>
                <spr:UpdatedBy>string</spr:UpdatedBy>
                <spr:UpdatedDate>dateTime</spr:UpdatedDate>
                <spr:Security>list of enumerated string values</spr:Security>
                <spr:Description>string</spr:Description>
                <spr:Metadata>
                    <spr:SCMMetadata>
                        <spr:GroupName>string</spr:GroupName>
                        <spr:FieldName>string</spr:FieldName>
                        <spr:Value>string</spr:Value>
                        <spr:HighValue>string</spr:HighValue>
                        <spr:ExcludeFromSearch>true</spr:ExcludeFromSearch>
                        <spr:SetName>string</spr:SetName>
                        <spr:SetNumber>1042</spr:SetNumber>
                        <spr:DataType>String</spr:DataType>
                    </spr:SCMMetadata>
                </spr:Metadata>
                <spr:LimitAttributeGroups>
                    <spr:string>string</spr:string>
                </spr:LimitAttributeGroups>
            </spr:destination>
            <spr:destinationName>string</spr:destinationName>
        </spr:DocumentXMLMerge>
    </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:DocumentXMLMergeResponse>
            <spr:DocumentXMLMergeResult>string</spr:DocumentXMLMergeResult>
        </spr:DocumentXMLMergeResponse>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentXMLMerge

Request XML

Response XML