Chilkat Tools

SpringCMServiceSoap / DocumentSearch

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

Dim xml As New ChilkatXml
xml.Tag = "soapenv:Envelope"
success = xml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
success = xml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
xml.UpdateChildContent "soapenv:Header",""
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:token","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:AtLeastOneWord","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:WithAllWords","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:WithoutWords","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:WithPhrase","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:StartDate","dateTime"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:EndDate","dateTime"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:LimitFolderId","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:LimitIncludeSubfolders","true"
xml.UpdateChildContentInt "soapenv:Body|spr:DocumentSearch|spr:search|spr:StartHitIndex",1042
xml.UpdateChildContentInt "soapenv:Body|spr:DocumentSearch|spr:search|spr:MaxHits",1042
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Body","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Extensions|spr:string","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Description","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:GroupName","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:FieldName","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:Value","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:HighValue","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetName","string"
xml.UpdateChildContentInt "soapenv:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:DataType","String"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:ReceivedFrom","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:ShowRevisions","true"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:Title","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|spr:search|spr:InAnyAttributeField","string"
xml.UpdateChildContent "soapenv:Body|spr:DocumentSearch|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 = 0
Dim soapRequestBody As String
soapRequestBody = xml.GetXml()

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

Dim http As New ChilkatHttp

http.ClearHeaders 
http.SetRequestHeader "Content-Type",contentType
http.SetRequestHeader "SOAPAction",soapAction

Dim resp As ChilkatHttpResponse
Set resp = http.PostXml(endpoint,soapRequestBody,"utf-8")
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Debug.Print "Failed to send SOAP request."
    Exit Sub
End If

' Get the XML response body.
Dim responseXml As New ChilkatXml
success = resp.GetBodyXml(responseXml)

Dim statusCode As Long
statusCode = resp.StatusCode
Debug.Print "response status code: " & statusCode

' If the status code does not indicate succcess, then show the response XML,
' which probably contains error information.
If (statusCode <> 200) Then
    Debug.Print responseXml.GetXml()
    Exit Sub
End If

Debug.Print 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).

Dim Id As String
Id = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Id")
Dim Name As String
Name = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Name")
Dim ObjectType As String
ObjectType = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ObjectType")
Dim ParentFolderId As String
ParentFolderId = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ParentFolderId")
Dim CreatedBy As String
CreatedBy = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CreatedBy")
Dim CreatedDate As String
CreatedDate = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CreatedDate")
Dim UpdatedBy As String
UpdatedBy = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:UpdatedBy")
Dim UpdatedDate As String
UpdatedDate = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:UpdatedDate")
Dim Security As String
Security = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Security")
Dim Description As String
Description = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Description")
Dim GroupName As String
GroupName = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName")
Dim FieldName As String
FieldName = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName")
Dim Value As String
Value = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value")
Dim HighValue As String
HighValue = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue")
Dim ExcludeFromSearch As String
ExcludeFromSearch = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
Dim SetName As String
SetName = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName")
Dim SetNumber As Long
SetNumber = responseXml.GetChildIntValue("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber")
Dim DataType As String
DataType = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType")
Dim CheckedOutUserId As String
CheckedOutUserId = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CheckedOutUserId")
Dim CheckedOutUserName As String
CheckedOutUserName = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CheckedOutUserName")
Dim ExpirationDate As String
ExpirationDate = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ExpirationDate")
Dim FileSize As Long
FileSize = responseXml.GetChildIntValue("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:FileSize")
Dim PDFFileSize As Long
PDFFileSize = responseXml.GetChildIntValue("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFFileSize")
Dim PDFConversion As String
PDFConversion = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFConversion")
Dim PDFPageCount As Long
PDFPageCount = responseXml.GetChildIntValue("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFPageCount")
Dim IsFormDocument As String
IsFormDocument = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:IsFormDocument")
Dim Key As String
Key = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key")
Value = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value")
SetName = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName")
Dim strSetNumber As String
strSetNumber = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber")
Dim MIMEType As String
MIMEType = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:MIMEType")
Dim Version As String
Version = responseXml.GetChildContent("*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Version")

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:DocumentSearch>
            <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:DocumentSearch>
    </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:DocumentSearchResponse>
            <spr:DocumentSearchResult>
                <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:DocumentSearchResult>
        </spr:DocumentSearchResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap / DocumentSearch

Request XML

Response XML