Chilkat Tools

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

Min Request Full Request

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set outFile = fso.CreateTextFile("output.txt", True)

set xml = CreateObject("Chilkat_9_5_0.Xml")
xml.Tag = "soap:Envelope"
success = xml.AddAttribute("xmlns:soap","http://www.w3.org/2003/05/soap-envelope")
success = xml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
xml.UpdateChildContent "soap:Header",""
xml.UpdateChildContent "soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:token","string"
xml.UpdateChildContent "soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:documentId","string"
xml.UpdateChildContent "soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:folderId","string"
xml.UpdateChildContent "soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:MustMatchMetadata","string"
xml.UpdateChildContent "soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:PartialMatchMetadata","string"
xml.UpdateChildContent "soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:ReturnAll","true"
xml.UpdateChildContent "soap: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 = 0
soapRequestBody = xml.GetXml()

endpoint = "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
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"
contentType = "text/xml"

set http = CreateObject("Chilkat_9_5_0.Http")

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

' resp is a Chilkat_9_5_0.HttpResponse
Set resp = http.PostXml(endpoint,soapRequestBody,"utf-8")
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    outFile.WriteLine("Failed to send SOAP request.")
    WScript.Quit
End If

' Get the XML response body.
set responseXml = CreateObject("Chilkat_9_5_0.Xml")
success = resp.GetBodyXml(responseXml)

statusCode = resp.StatusCode
outFile.WriteLine("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
    outFile.WriteLine(responseXml.GetXml())
    WScript.Quit
End If

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

outFile.Close

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

SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentGetMatchByIdAndMetadata

Request XML

Response XML