SpringCMServiceSoap / DocumentGetMatchByIdAndMetadata

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

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    var xml = new chilkat.Xml();
    xml.Tag = "soapenv:Envelope";
    xml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/");
    xml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/");
    xml.UpdateChildContent("soapenv:Header","");
    xml.UpdateChildContent("soapenv:Body|spr:DocumentGetMatchByIdAndMetadata|spr:token","string");
    xml.UpdateChildContent("soapenv:Body|spr:DocumentGetMatchByIdAndMetadata|spr:documentId","string");
    xml.UpdateChildContent("soapenv:Body|spr:DocumentGetMatchByIdAndMetadata|spr:folderId","string");
    xml.UpdateChildContent("soapenv:Body|spr:DocumentGetMatchByIdAndMetadata|spr:MustMatchMetadata","string");
    xml.UpdateChildContent("soapenv:Body|spr:DocumentGetMatchByIdAndMetadata|spr:PartialMatchMetadata","string");
    xml.UpdateChildContent("soapenv:Body|spr:DocumentGetMatchByIdAndMetadata|spr:ReturnAll","true");
    xml.UpdateChildContent("soapenv:Body|spr:DocumentGetMatchByIdAndMetadata|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 = false;
    var soapRequestBody = xml.GetXml();

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

    var http = new chilkat.Http();

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

    // resp: HttpResponse
    var resp = http.PostXml(endpoint,soapRequestBody,"utf-8");
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        console.log("Failed to send SOAP request.");
        return;
    }

    // Get the XML response body.
    var responseXml = new chilkat.Xml();
    resp.GetBodyXml(responseXml);

    var statusCode = resp.StatusCode;
    console.log("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) {
        console.log(responseXml.GetXml());
        return;
    }

    console.log(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).

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

}

chilkatExample();

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:DocumentGetMatchByIdAndMetadata>
            <spr:token>string</spr:token>
            <spr:documentId>string</spr:documentId>
            <spr:folderId>string</spr:folderId>
            <spr:MustMatchMetadata>string</spr:MustMatchMetadata>
            <spr:PartialMatchMetadata>string</spr:PartialMatchMetadata>
            <spr:ReturnAll>true</spr:ReturnAll>
            <spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
        </spr:DocumentGetMatchByIdAndMetadata>
    </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:DocumentGetMatchByIdAndMetadataResponse>
            <spr:DocumentGetMatchByIdAndMetadataResult>
                <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:DocumentGetMatchByIdAndMetadataResult>
        </spr:DocumentGetMatchByIdAndMetadataResponse>
    </soapenv:Body>
</soapenv:Envelope>