Chilkat Tools

SpringCMServiceSoap12 / FolderPagedSearch

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

LOCAL loXml
LOCAL lcSoapRequestBody
LOCAL lcEndpoint
LOCAL lcSoapAction
LOCAL lcContentType
LOCAL loHttp
LOCAL loResp
LOCAL loResponseXml
LOCAL lnStatusCode
LOCAL lcId
LOCAL lcName
LOCAL lcObjectType
LOCAL lcParentFolderId
LOCAL lcCreatedBy
LOCAL lcCreatedDate
LOCAL lcUpdatedBy
LOCAL lcUpdatedDate
LOCAL lcSecurity
LOCAL lcDescription
LOCAL lcGroupName
LOCAL lcFieldName
LOCAL lcValue
LOCAL lcHighValue
LOCAL lcExcludeFromSearch
LOCAL lcSetName
LOCAL lnSetNumber
LOCAL lcDataType
LOCAL lcCheckedOutUserId
LOCAL lcCheckedOutUserName
LOCAL lcExpirationDate
LOCAL lnFileSize
LOCAL lnPDFFileSize
LOCAL lcPDFConversion
LOCAL lnPDFPageCount
LOCAL lcIsFormDocument
LOCAL lcKey
LOCAL lcStrSetNumber
LOCAL lcMIMEType
LOCAL lcVersion
LOCAL lcV_string
LOCAL lcThereMayBeMoreHits
LOCAL lnQueriedMaxHits
LOCAL lnNativeHitCount

loXml = CreateObject('Chilkat_9_5_0.Xml')
loXml.Tag = "soap:Envelope"
loXml.AddAttribute("xmlns:soap","http://www.w3.org/2003/05/soap-envelope")
loXml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
loXml.UpdateChildContent("soap:Header","")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:token","string")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:AtLeastOneWord","string")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:WithAllWords","string")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:WithoutWords","string")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:WithPhrase","string")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:StartDate","dateTime")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:EndDate","dateTime")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:LimitFolderId","string")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:LimitIncludeSubfolders","true")
loXml.UpdateChildContentInt("soap:Body|spr:FolderPagedSearch|spr:search|spr:StartHitIndex",1042)
loXml.UpdateChildContentInt("soap:Body|spr:FolderPagedSearch|spr:search|spr:MaxHits",1042)
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:Name","string")
loXml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|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. 
loXml.EmitXmlDecl = 0
lcSoapRequestBody = loXml.GetXml()

lcEndpoint = "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
lcSoapAction = "http://www.springcm.com/atlas/webservices/v201308/scm/FolderPagedSearch"
*  For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
lcContentType = "text/xml"

loHttp = CreateObject('Chilkat_9_5_0.Http')

loHttp.ClearHeaders()
loHttp.SetRequestHeader("Content-Type",lcContentType)
loHttp.SetRequestHeader("SOAPAction",lcSoapAction)

loResp = loHttp.PostXml(lcEndpoint,lcSoapRequestBody,"utf-8")
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    ? "Failed to send SOAP request."
    RELEASE loXml
    RELEASE loHttp
    CANCEL
ENDIF

* Get the XML response body.
loResponseXml = CreateObject('Chilkat_9_5_0.Xml')
loResp.GetBodyXml(loResponseXml)

lnStatusCode = loResp.StatusCode
? "response status code: " + STR(lnStatusCode)

RELEASE loResp

* If the status code does not indicate succcess, then show the response XML,
* which probably contains error information.
IF (lnStatusCode <> 200) THEN
    ? loResponseXml.GetXml()
    RELEASE loXml
    RELEASE loHttp
    RELEASE loResponseXml
    CANCEL
ENDIF

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

lcId = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Id")
lcName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Name")
lcObjectType = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:ObjectType")
lcParentFolderId = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:ParentFolderId")
lcCreatedBy = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CreatedBy")
lcCreatedDate = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CreatedDate")
lcUpdatedBy = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:UpdatedBy")
lcUpdatedDate = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:UpdatedDate")
lcSecurity = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Security")
lcDescription = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Description")
lcGroupName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName")
lcFieldName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName")
lcValue = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value")
lcHighValue = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue")
lcExcludeFromSearch = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
lcSetName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName")
lnSetNumber = loResponseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber")
lcDataType = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType")
lcCheckedOutUserId = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CheckedOutUserId")
lcCheckedOutUserName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CheckedOutUserName")
lcExpirationDate = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:ExpirationDate")
lnFileSize = loResponseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:FileSize")
lnPDFFileSize = loResponseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFFileSize")
lcPDFConversion = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFConversion")
lnPDFPageCount = loResponseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFPageCount")
lcIsFormDocument = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:IsFormDocument")
lcKey = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key")
lcValue = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value")
lcSetName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName")
lcStrSetNumber = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber")
lcMIMEType = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:MIMEType")
lcVersion = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Version")
lcId = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Id")
lcName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Name")
lcObjectType = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:ObjectType")
lcParentFolderId = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:ParentFolderId")
lcCreatedBy = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:CreatedBy")
lcCreatedDate = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:CreatedDate")
lcUpdatedBy = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:UpdatedBy")
lcUpdatedDate = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:UpdatedDate")
lcSecurity = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Security")
lcDescription = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Description")
lcGroupName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName")
lcFieldName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName")
lcValue = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value")
lcHighValue = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue")
lcExcludeFromSearch = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
lcSetName = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName")
lnSetNumber = loResponseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber")
lcDataType = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType")
lcV_string = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:LimitAttributeGroups|*:string")
lcThereMayBeMoreHits = loResponseXml.GetChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:ThereMayBeMoreHits")
lnQueriedMaxHits = loResponseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:QueriedMaxHits")
lnNativeHitCount = loResponseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:NativeHitCount")

RELEASE loXml
RELEASE loHttp
RELEASE loResponseXml

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:FolderPagedSearch>
            <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:Name>string</spr:Name>
            </spr:search>
            <spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
        </spr:FolderPagedSearch>
    </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:FolderPagedSearchResponse>
            <spr:FolderPagedSearchResult>
                <spr:DocResults>
                    <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:DocResults>
                <spr:FolderResults>
                    <spr:SCMFolder>
                        <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:SCMFolder>
                </spr:FolderResults>
                <spr:ThereMayBeMoreHits>true</spr:ThereMayBeMoreHits>
                <spr:QueriedMaxHits>1042</spr:QueriedMaxHits>
                <spr:NativeHitCount>1042</spr:NativeHitCount>
            </spr:FolderPagedSearchResult>
        </spr:FolderPagedSearchResponse>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / FolderPagedSearch

Request XML

Response XML