SpringCMServiceSoap12 / FolderSearch

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

    xml := chilkat.NewXml()
    xml.SetTag("soap:Envelope")
    xml.AddAttribute("xmlns:soap","http://www.w3.org/2003/05/soap-envelope")
    xml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
    xml.UpdateChildContent("soap:Header","")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:token","string")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:AtLeastOneWord","string")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:WithAllWords","string")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:WithoutWords","string")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:WithPhrase","string")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:StartDate","dateTime")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:EndDate","dateTime")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:LimitFolderId","string")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:LimitIncludeSubfolders","true")
    xml.UpdateChildContentInt("soap:Body|spr:FolderSearch|spr:search|spr:StartHitIndex",1042)
    xml.UpdateChildContentInt("soap:Body|spr:FolderSearch|spr:search|spr:MaxHits",1042)
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|spr:search|spr:Name","string")
    xml.UpdateChildContent("soap:Body|spr:FolderSearch|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.SetEmitXmlDecl(false)
    soapRequestBody := xml.GetXml()

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

    http := chilkat.NewHttp()

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

    resp := http.PostXml(endpoint,*soapRequestBody,"utf-8")
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        fmt.Println("Failed to send SOAP request.")
        xml.DisposeXml()
        http.DisposeHttp()
        return
    }

    // Get the XML response body.
    responseXml := chilkat.NewXml()
    resp.GetBodyXml(responseXml)

    statusCode := resp.StatusCode()
    fmt.Println("response status code: ", statusCode)

    resp.DisposeHttpResponse()

    // If the status code does not indicate succcess, then show the response XML,
    // which probably contains error information.
    if statusCode != 200 {
        fmt.Println(*responseXml.GetXml())
        xml.DisposeXml()
        http.DisposeHttp()
        responseXml.DisposeXml()
        return
    }

    fmt.Println(*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).

    Id := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Id")
    Name := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Name")
    ObjectType := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:ObjectType")
    ParentFolderId := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:ParentFolderId")
    CreatedBy := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:CreatedBy")
    CreatedDate := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:CreatedDate")
    UpdatedBy := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:UpdatedBy")
    UpdatedDate := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:UpdatedDate")
    Security := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Security")
    Description := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Description")
    GroupName := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName")
    FieldName := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName")
    Value := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value")
    HighValue := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue")
    ExcludeFromSearch := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
    SetName := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName")
    SetNumber := responseXml.GetChildIntValue("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber")
    DataType := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType")
    v_string := responseXml.GetChildContent("*:Body|*:FolderSearchResponse|*:FolderSearchResult|*:SCMFolder|*:LimitAttributeGroups|*:string")

    xml.DisposeXml()
    http.DisposeHttp()
    responseXml.DisposeXml()

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:FolderSearch>
            <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:Name>string</spr:Name>
            </spr:search>
            <spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
        </spr:FolderSearch>
    </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:FolderSearchResponse>
            <spr:FolderSearchResult>
                <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:FolderSearchResult>
        </spr:FolderSearchResponse>
    </soap:Body>
</soap:Envelope>