Chilkat Tools

SpringCMServiceSoap12 / 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

#include <CkXmlW.h>
#include <CkHttpW.h>
#include <CkHttpResponseW.h>

void ChilkatSample(void)
    {
    CkXmlW xml;
    xml.put_Tag(L"soap:Envelope");
    xml.AddAttribute(L"xmlns:soap",L"http://www.w3.org/2003/05/soap-envelope");
    xml.AddAttribute(L"xmlns:spr",L"http://www.springcm.com/atlas/webservices/v201308/scm/");
    xml.UpdateChildContent(L"soap:Header",L"");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:token",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:AtLeastOneWord",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:WithAllWords",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:WithoutWords",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:WithPhrase",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:StartDate",L"dateTime");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:EndDate",L"dateTime");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:LimitFolderId",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:LimitIncludeSubfolders",L"true");
    xml.UpdateChildContentInt(L"soap:Body|spr:DocumentSearch|spr:search|spr:StartHitIndex",1042);
    xml.UpdateChildContentInt(L"soap:Body|spr:DocumentSearch|spr:search|spr:MaxHits",1042);
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Body",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Extensions|spr:string",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Description",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:GroupName",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:FieldName",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:Value",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:HighValue",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch",L"true");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetName",L"string");
    xml.UpdateChildContentInt(L"soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042);
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Metadata|spr:SCMMetadata|spr:DataType",L"String");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:ReceivedFrom",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:ShowRevisions",L"true");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:Title",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|spr:search|spr:InAnyAttributeField",L"string");
    xml.UpdateChildContent(L"soap:Body|spr:DocumentSearch|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/DocumentSearch";
    //  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|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Id");
    const wchar_t *Name = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Name");
    const wchar_t *ObjectType = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ObjectType");
    const wchar_t *ParentFolderId = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ParentFolderId");
    const wchar_t *CreatedBy = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CreatedBy");
    const wchar_t *CreatedDate = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CreatedDate");
    const wchar_t *UpdatedBy = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:UpdatedBy");
    const wchar_t *UpdatedDate = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:UpdatedDate");
    const wchar_t *Security = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Security");
    const wchar_t *Description = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Description");
    const wchar_t *GroupName = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName");
    const wchar_t *FieldName = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName");
    const wchar_t *Value = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value");
    const wchar_t *HighValue = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue");
    const wchar_t *ExcludeFromSearch = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch");
    const wchar_t *SetName = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName");
    int SetNumber = responseXml.GetChildIntValue(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber");
    const wchar_t *DataType = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType");
    const wchar_t *CheckedOutUserId = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CheckedOutUserId");
    const wchar_t *CheckedOutUserName = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CheckedOutUserName");
    const wchar_t *ExpirationDate = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:ExpirationDate");
    int FileSize = responseXml.GetChildIntValue(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:FileSize");
    int PDFFileSize = responseXml.GetChildIntValue(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFFileSize");
    const wchar_t *PDFConversion = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFConversion");
    int PDFPageCount = responseXml.GetChildIntValue(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:PDFPageCount");
    const wchar_t *IsFormDocument = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:IsFormDocument");
    const wchar_t *Key = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key");
    Value = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value");
    SetName = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName");
    const wchar_t *strSetNumber = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber");
    const wchar_t *MIMEType = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:MIMEType");
    const wchar_t *Version = responseXml.getChildContent(L"*:Body|*:DocumentSearchResponse|*:DocumentSearchResult|*:SCMDocument|*:Version");
    }

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: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>
    </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: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>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentSearch

Request XML

Response XML