SOAP WSDL Generate Code

SpringCMServiceSoap / 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 
-- Important: See this note about {{-https://cknotes.com/sql-sp_oamethod-string-length-return-value-limitations/|||string length limitations for strings returned by sp_OAMethod calls-}}.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the {{-https://www.example-code.com/sql/default.asp|||warning about using nvarchar(max)-}}.
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @xml int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Xml', @xml OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @xml, 'Tag', 'soapenv:Envelope'
    DECLARE @success int
    EXEC sp_OAMethod @xml, 'AddAttribute', @success OUT, 'xmlns:soapenv', 'http://schemas.xmlsoap.org/soap/envelope/'
    EXEC sp_OAMethod @xml, 'AddAttribute', @success OUT, 'xmlns:spr', 'http://www.springcm.com/atlas/webservices/v201308/scm/'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Header', ''
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:token', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Id', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Name', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:ObjectType', 'Document'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:ParentFolderId', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:CreatedBy', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:CreatedDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:UpdatedBy', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:UpdatedDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Security', 'list of enumerated string values'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Description', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:GroupName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:FieldName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:Value', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:HighValue', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch', 'true'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:SetName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:SetNumber', 1042
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Metadata|spr:SCMMetadata|spr:DataType', 'String'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:CheckedOutUserId', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:CheckedOutUserName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:ExpirationDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:FileSize', 123456
    EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:PDFFileSize', 123456
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:PDFConversion', 'true'
    EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:PDFPageCount', 1042
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:IsFormDocument', 'true'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:CustomFormFields|spr:SCMFormField|spr:Key', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:CustomFormFields|spr:SCMFormField|spr:Value', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:CustomFormFields|spr:SCMFormField|spr:SetName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:MIMEType', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:template|spr:Version', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:SourceType', 'Document'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:Id', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:Name', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:ObjectType', 'Document'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:ParentFolderId', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:CreatedBy', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:CreatedDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:UpdatedBy', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:UpdatedDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:Security', 'list of enumerated string values'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:Object|spr:Description', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:dataSource|spr:String', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Id', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Name', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:ObjectType', 'Document'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:ParentFolderId', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:CreatedBy', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:CreatedDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:UpdatedBy', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:UpdatedDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Security', 'list of enumerated string values'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Description', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:GroupName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:FieldName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:Value', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:HighValue', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch', 'true'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:SetName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:SetNumber', 1042
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:Metadata|spr:SCMMetadata|spr:DataType', 'String'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|spr:DocumentXMLMerge|spr:destination|spr:LimitAttributeGroups|spr:string', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv: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. 
    EXEC sp_OASetProperty @xml, 'EmitXmlDecl', 0
    DECLARE @soapRequestBody nvarchar(4000)
    EXEC sp_OAMethod @xml, 'GetXml', @soapRequestBody OUT

    DECLARE @endpoint nvarchar(4000)
    SELECT @endpoint = 'https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx'
    DECLARE @soapAction nvarchar(4000)
    SELECT @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"
    DECLARE @contentType nvarchar(4000)
    SELECT @contentType = 'text/xml'

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT

    EXEC sp_OAMethod @http, 'ClearHeaders', NULL
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', @contentType
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'SOAPAction', @soapAction

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostXml', @resp OUT, @endpoint, @soapRequestBody, 'utf-8'
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed to send SOAP request.'
        EXEC @hr = sp_OADestroy @xml
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    -- Get the XML response body.
    DECLARE @responseXml int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Xml', @responseXml OUT

    EXEC sp_OAMethod @resp, 'GetBodyXml', @success OUT, @responseXml

    DECLARE @statusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @statusCode OUT

    PRINT 'response status code: ' + @statusCode

    EXEC @hr = sp_OADestroy @resp

    -- If the status code does not indicate succcess, then show the response XML,
    -- which probably contains error information.
    IF @statusCode <> 200
      BEGIN
        EXEC sp_OAMethod @responseXml, 'GetXml', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @xml
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @responseXml
        RETURN
      END

    EXEC sp_OAMethod @responseXml, 'GetXml', @sTmp0 OUT
    PRINT @sTmp0

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

    DECLARE @DocumentXMLMergeResult nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @DocumentXMLMergeResult OUT, '*:Body|*:DocumentXMLMergeResponse|*:DocumentXMLMergeResult'

    EXEC @hr = sp_OADestroy @xml
    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @responseXml


END
GO
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: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>
    </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:DocumentXMLMergeResponse>
            <spr:DocumentXMLMergeResult>string</spr:DocumentXMLMergeResult>
        </spr:DocumentXMLMergeResponse>
    </soapenv:Body>
</soapenv:Envelope>