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
import sys
import chilkat
xml = chilkat.CkXml()
xml.put_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:FolderPagedSearch|spr:token","string")
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:AtLeastOneWord","string")
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:WithAllWords","string")
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:WithoutWords","string")
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:WithPhrase","string")
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:StartDate","dateTime")
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:EndDate","dateTime")
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:LimitFolderId","string")
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:LimitIncludeSubfolders","true")
xml.UpdateChildContentInt("soap:Body|spr:FolderPagedSearch|spr:search|spr:StartHitIndex",1042)
xml.UpdateChildContentInt("soap:Body|spr:FolderPagedSearch|spr:search|spr:MaxHits",1042)
xml.UpdateChildContent("soap:Body|spr:FolderPagedSearch|spr:search|spr:Name","string")
xml.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.
xml.put_EmitXmlDecl(False)
soapRequestBody = xml.getXml()
endpoint = "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
soapAction = "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"
contentType = "text/xml"
http = chilkat.CkHttp()
http.ClearHeaders()
http.SetRequestHeader("Content-Type",contentType)
http.SetRequestHeader("SOAPAction",soapAction)
# resp is a CkHttpResponse
resp = http.PostXml(endpoint,soapRequestBody,"utf-8")
if (http.get_LastMethodSuccess() == False):
print(http.lastErrorText())
print("Failed to send SOAP request.")
sys.exit()
# Get the XML response body.
responseXml = chilkat.CkXml()
resp.GetBodyXml(responseXml)
statusCode = resp.get_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).
Id = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Id")
Name = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Name")
ObjectType = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:ObjectType")
ParentFolderId = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:ParentFolderId")
CreatedBy = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CreatedBy")
CreatedDate = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CreatedDate")
UpdatedBy = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:UpdatedBy")
UpdatedDate = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:UpdatedDate")
Security = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Security")
Description = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Description")
GroupName = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName")
FieldName = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName")
Value = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value")
HighValue = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue")
ExcludeFromSearch = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
SetName = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName")
SetNumber = responseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber")
DataType = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType")
CheckedOutUserId = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CheckedOutUserId")
CheckedOutUserName = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CheckedOutUserName")
ExpirationDate = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:ExpirationDate")
FileSize = responseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:FileSize")
PDFFileSize = responseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFFileSize")
PDFConversion = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFConversion")
PDFPageCount = responseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFPageCount")
IsFormDocument = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:IsFormDocument")
Key = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key")
Value = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value")
SetName = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName")
strSetNumber = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber")
MIMEType = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:MIMEType")
Version = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:DocResults|*:SCMDocument|*:Version")
Id = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Id")
Name = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Name")
ObjectType = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:ObjectType")
ParentFolderId = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:ParentFolderId")
CreatedBy = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:CreatedBy")
CreatedDate = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:CreatedDate")
UpdatedBy = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:UpdatedBy")
UpdatedDate = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:UpdatedDate")
Security = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Security")
Description = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Description")
GroupName = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName")
FieldName = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName")
Value = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value")
HighValue = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue")
ExcludeFromSearch = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
SetName = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName")
SetNumber = responseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber")
DataType = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType")
v_string = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:FolderResults|*:SCMFolder|*:LimitAttributeGroups|*:string")
ThereMayBeMoreHits = responseXml.getChildContent("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:ThereMayBeMoreHits")
QueriedMaxHits = responseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:QueriedMaxHits")
NativeHitCount = responseXml.GetChildIntValue("*:Body|*:FolderPagedSearchResponse|*:FolderPagedSearchResult|*:NativeHitCount")
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>