Chilkat Tools

SpringCMServiceSoap / FolderSearch

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 = "soapenv:Envelope";
xml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/");
xml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/");
xml.UpdateChildContent("soapenv:Header","");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:token","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:AtLeastOneWord","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:WithAllWords","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:WithoutWords","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:WithPhrase","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:StartDate","dateTime");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:EndDate","dateTime");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:LimitFolderId","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:LimitIncludeSubfolders","true");
xml.UpdateChildContentInt("soapenv:Body|spr:FolderSearch|spr:search|spr:StartHitIndex",1042);
xml.UpdateChildContentInt("soapenv:Body|spr:FolderSearch|spr:search|spr:MaxHits",1042);
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|spr:search|spr:Name","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderSearch|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/FolderSearch";
//  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|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Id");
string Name = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Name");
string ObjectType = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:ObjectType");
string ParentFolderId = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:ParentFolderId");
string CreatedBy = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:CreatedBy");
string CreatedDate = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:CreatedDate");
string UpdatedBy = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:UpdatedBy");
string UpdatedDate = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:UpdatedDate");
string Security = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Security");
string Description = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Description");
string GroupName = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName");
string FieldName = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName");
string Value = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value");
string HighValue = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue");
string ExcludeFromSearch = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
string SetName = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName");
int SetNumber = responseXml.GetChildIntValue("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber");
string DataType = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType");
string v_string = responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:LimitAttributeGroups|*:string");

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:FolderSearch>
            <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:FolderSearch>
    </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:FolderSearchResponse>
            <spr:FolderSearchResult>
                <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:FolderSearchResult>
        </spr:FolderSearchResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap / FolderSearch

Request XML

Response XML