SpringCMServiceSoap / FolderGetContents
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
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:FolderGetContents|spr:token","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderGetContents|spr:folderId","string");
xml.UpdateChildContent("soapenv:Body|spr:FolderGetContents|spr:loadExtendedMetadata","true");
xml.UpdateChildContentInt("soapenv:Body|spr:FolderGetContents|spr:pager|spr:StartIndex",1042);
xml.UpdateChildContentInt("soapenv:Body|spr:FolderGetContents|spr:pager|spr:PageSize",1042);
xml.UpdateChildContent("soapenv:Body|spr:FolderGetContents|spr:pager|spr:SortColumn","Name");
xml.UpdateChildContent("soapenv:Body|spr:FolderGetContents|spr:pager|spr:SortAscending","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/FolderGetContents";
// 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|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Id");
string Name = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Name");
string ObjectType = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ObjectType");
string ParentFolderId = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ParentFolderId");
string CreatedBy = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CreatedBy");
string CreatedDate = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CreatedDate");
string UpdatedBy = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:UpdatedBy");
string UpdatedDate = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:UpdatedDate");
string Security = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Security");
string Description = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Description");
string GroupName = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName");
string FieldName = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName");
string Value = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value");
string HighValue = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue");
string ExcludeFromSearch = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
string SetName = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName");
int SetNumber = responseXml.GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber");
string DataType = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType");
string CheckedOutUserId = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CheckedOutUserId");
string CheckedOutUserName = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CheckedOutUserName");
string ExpirationDate = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ExpirationDate");
int FileSize = responseXml.GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:FileSize");
int PDFFileSize = responseXml.GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFFileSize");
string PDFConversion = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFConversion");
int PDFPageCount = responseXml.GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFPageCount");
string IsFormDocument = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:IsFormDocument");
string Key = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key");
Value = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value");
SetName = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName");
string strSetNumber = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber");
string MIMEType = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:MIMEType");
string Version = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Version");
Id = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Id");
Name = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Name");
ObjectType = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:ObjectType");
ParentFolderId = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:ParentFolderId");
CreatedBy = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:CreatedBy");
CreatedDate = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:CreatedDate");
UpdatedBy = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:UpdatedBy");
UpdatedDate = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:UpdatedDate");
Security = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Security");
Description = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Description");
GroupName = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName");
FieldName = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName");
Value = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value");
HighValue = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue");
ExcludeFromSearch = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
SetName = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName");
SetNumber = responseXml.GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber");
DataType = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType");
string v_string = responseXml.GetChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:LimitAttributeGroups|*:string");
int TotalRowCount = responseXml.GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:TotalRowCount");
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:FolderGetContents>
<spr:token>string</spr:token>
<spr:folderId>string</spr:folderId>
<spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
<spr:pager>
<spr:StartIndex>1042</spr:StartIndex>
<spr:PageSize>1042</spr:PageSize>
<spr:SortColumn>Name</spr:SortColumn>
<spr:SortAscending>true</spr:SortAscending>
</spr:pager>
</spr:FolderGetContents>
</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:FolderGetContentsResponse>
<spr:FolderGetContentsResult>
<spr:SCMDocuments>
<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:SCMDocuments>
<spr:SCMFolders>
<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:SCMFolders>
<spr:TotalRowCount>1042</spr:TotalRowCount>
</spr:FolderGetContentsResult>
</spr:FolderGetContentsResponse>
</soapenv:Body>
</soapenv:Envelope>