Chilkat Tools

SpringCMServiceSoap12 / DocumentGetById

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

require 'chilkat'

xml = Chilkat::CkXml.new()
xml.put_Tag("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:DocumentGetById|spr:token","string")
xml.UpdateChildContent("soap:Body|spr:DocumentGetById|spr:documentId","string")
xml.UpdateChildContent("soap:Body|spr:DocumentGetById|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.put_EmitXmlDecl(false)
soapRequestBody = xml.getXml()

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

http = Chilkat::CkHttp.new()

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

# resp is a CkHttpResponse
resp = http.PostXml(endpoint,soapRequestBody,"utf-8")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    print "Failed to send SOAP request." + "\n";
    exit
end

# Get the XML response body.
responseXml = Chilkat::CkXml.new()
resp.GetBodyXml(responseXml)

statusCode = resp.get_StatusCode()
print "response status code: " + statusCode.to_s() + "\n";

# If the status code does not indicate succcess, then show the response XML,
# which probably contains error information.
if (statusCode != 200)
    print responseXml.getXml() + "\n";
    exit
end

print responseXml.getXml() + "\n";

# 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|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Id")
Name = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Name")
ObjectType = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:ObjectType")
ParentFolderId = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:ParentFolderId")
CreatedBy = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:CreatedBy")
CreatedDate = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:CreatedDate")
UpdatedBy = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:UpdatedBy")
UpdatedDate = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:UpdatedDate")
Security = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Security")
Description = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Description")
GroupName = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Metadata|*:SCMMetadata|*:GroupName")
FieldName = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Metadata|*:SCMMetadata|*:FieldName")
Value = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Metadata|*:SCMMetadata|*:Value")
HighValue = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Metadata|*:SCMMetadata|*:HighValue")
ExcludeFromSearch = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
SetName = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Metadata|*:SCMMetadata|*:SetName")
SetNumber = responseXml.GetChildIntValue("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Metadata|*:SCMMetadata|*:SetNumber")
DataType = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:Metadata|*:SCMMetadata|*:DataType")
CheckedOutUserId = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:CheckedOutUserId")
CheckedOutUserName = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:CheckedOutUserName")
ExpirationDate = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:ExpirationDate")
FileSize = responseXml.GetChildIntValue("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:FileSize")
PDFFileSize = responseXml.GetChildIntValue("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:PDFFileSize")
PDFConversion = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:PDFConversion")
PDFPageCount = responseXml.GetChildIntValue("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:PDFPageCount")
IsFormDocument = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:IsFormDocument")
Key = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:CustomFormFields|*:SCMFormField|*:Key")
Value = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:CustomFormFields|*:SCMFormField|*:Value")
SetName = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:CustomFormFields|*:SCMFormField|*:SetName")
strSetNumber = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:CustomFormFields|*:SCMFormField|*:SetNumber")
MIMEType = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*:MIMEType")
Version = responseXml.getChildContent("*:Body|*:DocumentGetByIdResponse|*:DocumentGetByIdResult|*: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:DocumentGetById>
            <spr:token>string</spr:token>
            <spr:documentId>string</spr:documentId>
            <spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
        </spr:DocumentGetById>
    </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:DocumentGetByIdResponse>
            <spr:DocumentGetByIdResult>
                <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:DocumentGetByIdResult>
        </spr:DocumentGetByIdResponse>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentGetById

Request XML

Response XML