Chilkat Tools

SpringCMServiceSoap12 / DocumentPagedSearch

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

Chilkat.Xml xml = new Chilkat.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:DocumentPagedSearch|spr:token","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:AtLeastOneWord","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:WithAllWords","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:WithoutWords","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:WithPhrase","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:StartDate","dateTime");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:EndDate","dateTime");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:LimitFolderId","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:LimitIncludeSubfolders","true");
xml.UpdateChildContentInt("soap:Body|spr:DocumentPagedSearch|spr:search|spr:StartHitIndex",1042);
xml.UpdateChildContentInt("soap:Body|spr:DocumentPagedSearch|spr:search|spr:MaxHits",1042);
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Body","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Extensions|spr:string","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Description","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:GroupName","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:FieldName","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:Value","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:HighValue","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetName","string");
xml.UpdateChildContentInt("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042);
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:DataType","String");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:ReceivedFrom","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:ShowRevisions","true");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:Title","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|spr:search|spr:InAnyAttributeField","string");
xml.UpdateChildContent("soap:Body|spr:DocumentPagedSearch|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.EmitXmlDecl = false;
string soapRequestBody = xml.GetXml();

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

Chilkat.Http http = new Chilkat.Http();

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

Chilkat.HttpResponse resp = http.PostXml(endpoint,soapRequestBody,"utf-8");
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    Debug.WriteLine("Failed to send SOAP request.");
    return;
}

// Get the XML response body.
Chilkat.Xml responseXml = new Chilkat.Xml();
resp.GetBodyXml(responseXml);

int statusCode = resp.StatusCode;
Debug.WriteLine("response status code: " + Convert.ToString(statusCode));

// If the status code does not indicate succcess, then show the response XML,
// which probably contains error information.
if (statusCode != 200) {
    Debug.WriteLine(responseXml.GetXml());
    return;
}

Debug.WriteLine(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).

string Id = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Id");
string Name = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Name");
string ObjectType = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:ObjectType");
string ParentFolderId = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:ParentFolderId");
string CreatedBy = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CreatedBy");
string CreatedDate = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CreatedDate");
string UpdatedBy = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:UpdatedBy");
string UpdatedDate = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:UpdatedDate");
string Security = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Security");
string Description = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Description");
string GroupName = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName");
string FieldName = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName");
string Value = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value");
string HighValue = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue");
string ExcludeFromSearch = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
string SetName = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName");
int SetNumber = responseXml.GetChildIntValue("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber");
string DataType = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType");
string CheckedOutUserId = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CheckedOutUserId");
string CheckedOutUserName = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CheckedOutUserName");
string ExpirationDate = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:ExpirationDate");
int FileSize = responseXml.GetChildIntValue("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:FileSize");
int PDFFileSize = responseXml.GetChildIntValue("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFFileSize");
string PDFConversion = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFConversion");
int PDFPageCount = responseXml.GetChildIntValue("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFPageCount");
string IsFormDocument = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:IsFormDocument");
string Key = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key");
Value = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value");
SetName = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName");
string strSetNumber = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber");
string MIMEType = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:MIMEType");
string Version = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Version");
Id = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Id");
Name = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Name");
ObjectType = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:ObjectType");
ParentFolderId = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:ParentFolderId");
CreatedBy = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:CreatedBy");
CreatedDate = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:CreatedDate");
UpdatedBy = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:UpdatedBy");
UpdatedDate = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:UpdatedDate");
Security = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Security");
Description = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Description");
GroupName = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName");
FieldName = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName");
Value = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value");
HighValue = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue");
ExcludeFromSearch = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
SetName = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName");
SetNumber = responseXml.GetChildIntValue("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber");
DataType = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType");
string v_string = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:LimitAttributeGroups|*:string");
string ThereMayBeMoreHits = responseXml.GetChildContent("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:ThereMayBeMoreHits");
int QueriedMaxHits = responseXml.GetChildIntValue("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:QueriedMaxHits");
int NativeHitCount = responseXml.GetChildIntValue("*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*: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:DocumentPagedSearch>
            <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:DocumentPagedSearch>
    </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:DocumentPagedSearchResponse>
            <spr:DocumentPagedSearchResult>
                <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:DocumentPagedSearchResult>
        </spr:DocumentPagedSearchResponse>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentPagedSearch

Request XML

Response XML