SpringCMServiceSoap / 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
#include <CkXmlW.h>
#include <CkHttpW.h>
#include <CkHttpResponseW.h>
void ChilkatSample(void)
{
CkXmlW xml;
xml.put_Tag(L"soapenv:Envelope");
xml.AddAttribute(L"xmlns:soapenv",L"http://schemas.xmlsoap.org/soap/envelope/");
xml.AddAttribute(L"xmlns:spr",L"http://www.springcm.com/atlas/webservices/v201308/scm/");
xml.UpdateChildContent(L"soapenv:Header",L"");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:token",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:AtLeastOneWord",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:WithAllWords",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:WithoutWords",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:WithPhrase",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:StartDate",L"dateTime");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:EndDate",L"dateTime");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:LimitFolderId",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:LimitIncludeSubfolders",L"true");
xml.UpdateChildContentInt(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:StartHitIndex",1042);
xml.UpdateChildContentInt(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:MaxHits",1042);
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Body",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Extensions|spr:string",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Description",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:GroupName",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:FieldName",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:Value",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:HighValue",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch",L"true");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetName",L"string");
xml.UpdateChildContentInt(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042);
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:DataType",L"String");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:ReceivedFrom",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:ShowRevisions",L"true");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:Title",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:search|spr:InAnyAttributeField",L"string");
xml.UpdateChildContent(L"soapenv:Body|spr:DocumentPagedSearch|spr:loadExtendedMetadata",L"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);
const wchar_t *soapRequestBody = xml.getXml();
const wchar_t *endpoint = L"https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx";
const wchar_t *soapAction = L"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"
const wchar_t *contentType = L"text/xml";
CkHttpW http;
http.ClearHeaders();
http.SetRequestHeader(L"Content-Type",contentType);
http.SetRequestHeader(L"SOAPAction",soapAction);
CkHttpResponseW *resp = http.PostXml(endpoint,soapRequestBody,L"utf-8");
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
wprintf(L"Failed to send SOAP request.\n");
return;
}
// Get the XML response body.
CkXmlW responseXml;
resp->GetBodyXml(responseXml);
int statusCode = resp->get_StatusCode();
wprintf(L"response status code: %d\n",statusCode);
delete resp;
// If the status code does not indicate succcess, then show the response XML,
// which probably contains error information.
if (statusCode != 200) {
wprintf(L"%s\n",responseXml.getXml());
return;
}
wprintf(L"%s\n",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).
const wchar_t *Id = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Id");
const wchar_t *Name = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Name");
const wchar_t *ObjectType = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:ObjectType");
const wchar_t *ParentFolderId = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:ParentFolderId");
const wchar_t *CreatedBy = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CreatedBy");
const wchar_t *CreatedDate = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CreatedDate");
const wchar_t *UpdatedBy = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:UpdatedBy");
const wchar_t *UpdatedDate = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:UpdatedDate");
const wchar_t *Security = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Security");
const wchar_t *Description = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Description");
const wchar_t *GroupName = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName");
const wchar_t *FieldName = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName");
const wchar_t *Value = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value");
const wchar_t *HighValue = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue");
const wchar_t *ExcludeFromSearch = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
const wchar_t *SetName = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName");
int SetNumber = responseXml.GetChildIntValue(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber");
const wchar_t *DataType = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType");
const wchar_t *CheckedOutUserId = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CheckedOutUserId");
const wchar_t *CheckedOutUserName = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CheckedOutUserName");
const wchar_t *ExpirationDate = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:ExpirationDate");
int FileSize = responseXml.GetChildIntValue(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:FileSize");
int PDFFileSize = responseXml.GetChildIntValue(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFFileSize");
const wchar_t *PDFConversion = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFConversion");
int PDFPageCount = responseXml.GetChildIntValue(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:PDFPageCount");
const wchar_t *IsFormDocument = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:IsFormDocument");
const wchar_t *Key = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key");
Value = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value");
SetName = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName");
const wchar_t *strSetNumber = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber");
const wchar_t *MIMEType = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:MIMEType");
const wchar_t *Version = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:DocResults|*:SCMDocument|*:Version");
Id = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Id");
Name = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Name");
ObjectType = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:ObjectType");
ParentFolderId = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:ParentFolderId");
CreatedBy = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:CreatedBy");
CreatedDate = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:CreatedDate");
UpdatedBy = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:UpdatedBy");
UpdatedDate = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:UpdatedDate");
Security = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Security");
Description = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Description");
GroupName = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName");
FieldName = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName");
Value = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value");
HighValue = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue");
ExcludeFromSearch = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
SetName = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName");
SetNumber = responseXml.GetChildIntValue(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber");
DataType = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType");
const wchar_t *v_string = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:FolderResults|*:SCMFolder|*:LimitAttributeGroups|*:string");
const wchar_t *ThereMayBeMoreHits = responseXml.getChildContent(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:ThereMayBeMoreHits");
int QueriedMaxHits = responseXml.GetChildIntValue(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:QueriedMaxHits");
int NativeHitCount = responseXml.GetChildIntValue(L"*:Body|*:DocumentPagedSearchResponse|*:DocumentPagedSearchResult|*:NativeHitCount");
}
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: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>
</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: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>
</soapenv:Body>
</soapenv:Envelope>