Chilkat Tools

SpringCMServiceSoap12 / SystemFolderGetContents

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

load ./chilkat.dll

set xml [new_CkXml]

CkXml_put_Tag $xml "soap:Envelope"
CkXml_AddAttribute $xml "xmlns:soap" "http://www.w3.org/2003/05/soap-envelope"
CkXml_AddAttribute $xml "xmlns:spr" "http://www.springcm.com/atlas/webservices/v201308/scm/"
CkXml_UpdateChildContent $xml "soap:Header" ""
CkXml_UpdateChildContent $xml "soap:Body|spr:SystemFolderGetContents|spr:token" "string"
CkXml_UpdateChildContent $xml "soap:Body|spr:SystemFolderGetContents|spr:systemFolder" "Inbox"
CkXml_UpdateChildContent $xml "soap:Body|spr:SystemFolderGetContents|spr:loadExtendedMetadata" "true"
CkXml_UpdateChildContentInt $xml "soap:Body|spr:SystemFolderGetContents|spr:pager|spr:StartIndex" 1042
CkXml_UpdateChildContentInt $xml "soap:Body|spr:SystemFolderGetContents|spr:pager|spr:PageSize" 1042
CkXml_UpdateChildContent $xml "soap:Body|spr:SystemFolderGetContents|spr:pager|spr:SortColumn" "Name"
CkXml_UpdateChildContent $xml "soap:Body|spr:SystemFolderGetContents|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. 
CkXml_put_EmitXmlDecl $xml 0
set soapRequestBody [CkXml_getXml $xml]

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

set http [new_CkHttp]

CkHttp_ClearHeaders $http
CkHttp_SetRequestHeader $http "Content-Type" $contentType
CkHttp_SetRequestHeader $http "SOAPAction" $soapAction

# resp is a CkHttpResponse
set resp [CkHttp_PostXml $http $endpoint $soapRequestBody "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    puts "Failed to send SOAP request."
    delete_CkXml $xml
    delete_CkHttp $http
    exit
}

# Get the XML response body.
set responseXml [new_CkXml]

CkHttpResponse_GetBodyXml $resp $responseXml

set statusCode [CkHttpResponse_get_StatusCode $resp]
puts "response status code: $statusCode"

delete_CkHttpResponse $resp

# If the status code does not indicate succcess, then show the response XML,
# which probably contains error information.
if {$statusCode != 200} then {
    puts [CkXml_getXml $responseXml]
    delete_CkXml $xml
    delete_CkHttp $http
    delete_CkXml $responseXml
    exit
}

puts [CkXml_getXml $responseXml]

# 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).

set Id [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Id"]
set Name [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Name"]
set ObjectType [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ObjectType"]
set ParentFolderId [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ParentFolderId"]
set CreatedBy [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CreatedBy"]
set CreatedDate [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CreatedDate"]
set UpdatedBy [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:UpdatedBy"]
set UpdatedDate [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:UpdatedDate"]
set Security [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Security"]
set Description [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Description"]
set GroupName [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName"]
set FieldName [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName"]
set Value [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value"]
set HighValue [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue"]
set ExcludeFromSearch [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch"]
set SetName [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName"]
set SetNumber [CkXml_GetChildIntValue $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber"]
set DataType [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType"]
set CheckedOutUserId [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CheckedOutUserId"]
set CheckedOutUserName [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CheckedOutUserName"]
set ExpirationDate [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ExpirationDate"]
set FileSize [CkXml_GetChildIntValue $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:FileSize"]
set PDFFileSize [CkXml_GetChildIntValue $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFFileSize"]
set PDFConversion [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFConversion"]
set PDFPageCount [CkXml_GetChildIntValue $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFPageCount"]
set IsFormDocument [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:IsFormDocument"]
set Key [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key"]
set Value [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value"]
set SetName [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName"]
set strSetNumber [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber"]
set MIMEType [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:MIMEType"]
set Version [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Version"]
set Id [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Id"]
set Name [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Name"]
set ObjectType [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:ObjectType"]
set ParentFolderId [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:ParentFolderId"]
set CreatedBy [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:CreatedBy"]
set CreatedDate [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:CreatedDate"]
set UpdatedBy [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:UpdatedBy"]
set UpdatedDate [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:UpdatedDate"]
set Security [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Security"]
set Description [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Description"]
set GroupName [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName"]
set FieldName [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName"]
set Value [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value"]
set HighValue [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue"]
set ExcludeFromSearch [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch"]
set SetName [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName"]
set SetNumber [CkXml_GetChildIntValue $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber"]
set DataType [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType"]
set v_string [CkXml_getChildContent $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:LimitAttributeGroups|*:string"]
set TotalRowCount [CkXml_GetChildIntValue $responseXml "*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:TotalRowCount"]

delete_CkXml $xml
delete_CkHttp $http
delete_CkXml $responseXml

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:SystemFolderGetContents>
            <spr:token>string</spr:token>
            <spr:systemFolder>Inbox</spr:systemFolder>
            <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:SystemFolderGetContents>
    </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:SystemFolderGetContentsResponse>
            <spr:SystemFolderGetContentsResult>
                <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:SystemFolderGetContentsResult>
        </spr:SystemFolderGetContentsResponse>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / SystemFolderGetContents

Request XML

Response XML