SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentSearch

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', 'soap:Envelope'
    DECLARE @success int
    EXEC sp_OAMethod @xml, 'AddAttribute', @success OUT, 'xmlns:soap', 'http://www.w3.org/2003/05/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, 'soap:Header', ''
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:token', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:AtLeastOneWord', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:WithAllWords', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:WithoutWords', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:WithPhrase', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:StartDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:EndDate', 'dateTime'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:LimitFolderId', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:LimitIncludeSubfolders', 'true'
    EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:StartHitIndex', 1042
    EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:MaxHits', 1042
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Body', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Extensions|spr:string', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Description', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:GroupName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:FieldName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:Value', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:HighValue', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch', 'true'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetName', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetNumber', 1042
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:DataType', 'String'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:ReceivedFrom', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:ShowRevisions', 'true'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:Title', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:search|spr:InAnyAttributeField', 'string'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soap:Body|spr:DocumentSearch|spr:loadExtendedMetadata', 'true'

    -- 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/DocumentSearch'
    --  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 @Id nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @Id OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Id'
    DECLARE @Name nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @Name OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Name'
    DECLARE @ObjectType nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @ObjectType OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ObjectType'
    DECLARE @ParentFolderId nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @ParentFolderId OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ParentFolderId'
    DECLARE @CreatedBy nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @CreatedBy OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CreatedBy'
    DECLARE @CreatedDate nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @CreatedDate OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CreatedDate'
    DECLARE @UpdatedBy nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @UpdatedBy OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:UpdatedBy'
    DECLARE @UpdatedDate nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @UpdatedDate OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:UpdatedDate'
    DECLARE @Security nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @Security OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Security'
    DECLARE @Description nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @Description OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Description'
    DECLARE @GroupName nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @GroupName OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName'
    DECLARE @FieldName nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @FieldName OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName'
    DECLARE @Value nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @Value OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value'
    DECLARE @HighValue nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @HighValue OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue'
    DECLARE @ExcludeFromSearch nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @ExcludeFromSearch OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch'
    DECLARE @SetName nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @SetName OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName'
    DECLARE @SetNumber int
    EXEC sp_OAMethod @responseXml, 'GetChildIntValue', @SetNumber OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber'
    DECLARE @DataType nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @DataType OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType'
    DECLARE @CheckedOutUserId nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @CheckedOutUserId OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CheckedOutUserId'
    DECLARE @CheckedOutUserName nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @CheckedOutUserName OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CheckedOutUserName'
    DECLARE @ExpirationDate nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @ExpirationDate OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ExpirationDate'
    DECLARE @FileSize int
    EXEC sp_OAMethod @responseXml, 'GetChildIntValue', @FileSize OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:FileSize'
    DECLARE @PDFFileSize int
    EXEC sp_OAMethod @responseXml, 'GetChildIntValue', @PDFFileSize OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFFileSize'
    DECLARE @PDFConversion nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @PDFConversion OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFConversion'
    DECLARE @PDFPageCount int
    EXEC sp_OAMethod @responseXml, 'GetChildIntValue', @PDFPageCount OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFPageCount'
    DECLARE @IsFormDocument nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @IsFormDocument OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:IsFormDocument'
    DECLARE @Key nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @Key OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key'
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @Value OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value'
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @SetName OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName'
    DECLARE @strSetNumber nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @strSetNumber OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber'
    DECLARE @MIMEType nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @MIMEType OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:MIMEType'
    DECLARE @Version nvarchar(4000)
    EXEC sp_OAMethod @responseXml, 'GetChildContent', @Version OUT, '*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Version'

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


END
GO
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:DocumentSearch>
            <spr:token>string</spr:token>
            <spr:search>
                <spr:AtLeastOneWord>string</spr:AtLeastOneWord>
                <spr:WithAllWords>string</spr:WithAllWords>
                <spr:WithoutWords>string</spr:WithoutWords>
                <spr:WithPhrase>string</spr:WithPhrase>
                <spr:StartDate>dateTime</spr:StartDate>
                <spr:EndDate>dateTime</spr:EndDate>
                <spr:LimitFolderId>string</spr:LimitFolderId>
                <spr:LimitIncludeSubfolders>true</spr:LimitIncludeSubfolders>
                <spr:StartHitIndex>1042</spr:StartHitIndex>
                <spr:MaxHits>1042</spr:MaxHits>
                <spr:Body>string</spr:Body>
                <spr:Extensions>
                    <spr:string>string</spr:string>
                </spr:Extensions>
                <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:ReceivedFrom>string</spr:ReceivedFrom>
                <spr:ShowRevisions>true</spr:ShowRevisions>
                <spr:Title>string</spr:Title>
                <spr:InAnyAttributeField>string</spr:InAnyAttributeField>
            </spr:search>
            <spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
        </spr:DocumentSearch>
    </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:DocumentSearchResponse>
            <spr:DocumentSearchResult>
                <spr:SCMDocument>
                    <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:SCMDocument>
            </spr:DocumentSearchResult>
        </spr:DocumentSearchResponse>
    </soap:Body>
</soap:Envelope>