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
use chilkat();
$xml = chilkat::CkXml->new();
$xml->put_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->put_EmitXmlDecl(0);
$soapRequestBody = $xml->getXml();
$endpoint = "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx";
$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"
$contentType = "text/xml";
$http = chilkat::CkHttp->new();
$http->ClearHeaders();
$http->SetRequestHeader("Content-Type",$contentType);
$http->SetRequestHeader("SOAPAction",$soapAction);
# resp is a HttpResponse
$resp = $http->PostXml($endpoint,$soapRequestBody,"utf-8");
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
print "Failed to send SOAP request." . "\r\n";
exit;
}
# Get the XML response body.
$responseXml = chilkat::CkXml->new();
$resp->GetBodyXml($responseXml);
$statusCode = $resp->get_StatusCode();
print "response status code: " . $statusCode . "\r\n";
# If the status code does not indicate succcess, then show the response XML,
# which probably contains error information.
if ($statusCode != 200) {
print $responseXml->getXml() . "\r\n";
exit;
}
print $responseXml->getXml() . "\r\n";
# 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|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Id");
$Name = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Name");
$ObjectType = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ObjectType");
$ParentFolderId = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ParentFolderId");
$CreatedBy = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CreatedBy");
$CreatedDate = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CreatedDate");
$UpdatedBy = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:UpdatedBy");
$UpdatedDate = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:UpdatedDate");
$Security = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Security");
$Description = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Description");
$GroupName = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName");
$FieldName = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName");
$Value = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value");
$HighValue = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue");
$ExcludeFromSearch = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
$SetName = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName");
$SetNumber = $responseXml->GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber");
$DataType = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType");
$CheckedOutUserId = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CheckedOutUserId");
$CheckedOutUserName = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CheckedOutUserName");
$ExpirationDate = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ExpirationDate");
$FileSize = $responseXml->GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:FileSize");
$PDFFileSize = $responseXml->GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFFileSize");
$PDFConversion = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFConversion");
$PDFPageCount = $responseXml->GetChildIntValue("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFPageCount");
$IsFormDocument = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:IsFormDocument");
$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");
$strSetNumber = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber");
$MIMEType = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:MIMEType");
$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");
$v_string = $responseXml->getChildContent("*:Body|*:FolderGetContentsResponse|*:FolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:LimitAttributeGroups|*:string");
$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>