Chilkat Tools

SpringCMServiceSoap / DocumentCreateFilesBegin

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

load ./chilkat.dll

set xml [new_CkXml]

CkXml_put_Tag $xml "soapenv:Envelope"
CkXml_AddAttribute $xml "xmlns:soapenv" "http://schemas.xmlsoap.org/soap/envelope/"
CkXml_AddAttribute $xml "xmlns:spr" "http://www.springcm.com/atlas/webservices/v201308/scm/"
CkXml_UpdateChildContent $xml "soapenv:Header" ""
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:token" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Id" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Name" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:ObjectType" "Document"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:ParentFolderId" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CreatedBy" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CreatedDate" "dateTime"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:UpdatedBy" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:UpdatedDate" "dateTime"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Security" "list of enumerated string values"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Description" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:GroupName" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:FieldName" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:Value" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:HighValue" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch" "true"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:SetName" "string"
CkXml_UpdateChildContentInt $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:SetNumber" 1042
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:DataType" "String"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CheckedOutUserId" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CheckedOutUserName" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:ExpirationDate" "dateTime"
CkXml_UpdateChildContentInt $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:FileSize" 123456
CkXml_UpdateChildContentInt $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:PDFFileSize" 123456
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:PDFConversion" "true"
CkXml_UpdateChildContentInt $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:PDFPageCount" 1042
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:IsFormDocument" "true"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CustomFormFields|spr:SCMFormField|spr:Key" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CustomFormFields|spr:SCMFormField|spr:Value" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CustomFormFields|spr:SCMFormField|spr:SetName" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:MIMEType" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Version" "string"
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:md5Hash" "BqozVXeZZg=="
CkXml_UpdateChildContentInt $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:pdfFileSize" 123456
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:pdfMd5Hash" "BqozVXeZZg=="
CkXml_UpdateChildContentInt $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:contentFileSize" 123456
CkXml_UpdateChildContent $xml "soapenv:Body|spr:DocumentCreateFilesBegin|spr:contentMd5Hash" "BqozVXeZZg=="

# In a SOAP HTTP request, including the XML declaration (<?xml version="1.0" encoding="UTF-8"?>) in the XML body is generally not required. 
CkXml_put_EmitXmlDecl $xml 0
set soapRequestBody [CkXml_getXml $xml]

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

set http [new_CkHttp]

CkHttp_ClearHeaders $http
CkHttp_SetRequestHeader $http "Content-Type" $contentType
CkHttp_SetRequestHeader $http "SOAPAction" $soapAction

# resp is a CkHttpResponse
set resp [CkHttp_PostXml $http $endpoint $soapRequestBody "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    puts "Failed to send SOAP request."
    delete_CkXml $xml
    delete_CkHttp $http
    exit
}

# Get the XML response body.
set responseXml [new_CkXml]

CkHttpResponse_GetBodyXml $resp $responseXml

set statusCode [CkHttpResponse_get_StatusCode $resp]
puts "response status code: $statusCode"

delete_CkHttpResponse $resp

# If the status code does not indicate succcess, then show the response XML,
# which probably contains error information.
if {$statusCode != 200} then {
    puts [CkXml_getXml $responseXml]
    delete_CkXml $xml
    delete_CkHttp $http
    delete_CkXml $responseXml
    exit
}

puts [CkXml_getXml $responseXml]

# 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).

set FileIdentifier [CkXml_getChildContent $responseXml "*:Body|*:DocumentCreateFilesBeginResponse|*:DocumentCreateFilesBeginResult|*:FileIdentifier"]
set PDFFileIdentifier [CkXml_getChildContent $responseXml "*:Body|*:DocumentCreateFilesBeginResponse|*:DocumentCreateFilesBeginResult|*:PDFFileIdentifier"]
set ContentFileIdentifier [CkXml_getChildContent $responseXml "*:Body|*:DocumentCreateFilesBeginResponse|*:DocumentCreateFilesBeginResult|*:ContentFileIdentifier"]
set ChunkSize [CkXml_GetChildIntValue $responseXml "*:Body|*:DocumentCreateFilesBeginResponse|*:DocumentCreateFilesBeginResult|*:ChunkSize"]

delete_CkXml $xml
delete_CkHttp $http
delete_CkXml $responseXml

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:DocumentCreateFilesBegin>
            <spr:token>string</spr:token>
            <spr:document>
                <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:document>
            <spr:md5Hash>BqozVXeZZg==</spr:md5Hash>
            <spr:pdfFileSize>123456</spr:pdfFileSize>
            <spr:pdfMd5Hash>BqozVXeZZg==</spr:pdfMd5Hash>
            <spr:contentFileSize>123456</spr:contentFileSize>
            <spr:contentMd5Hash>BqozVXeZZg==</spr:contentMd5Hash>
        </spr:DocumentCreateFilesBegin>
    </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:DocumentCreateFilesBeginResponse>
            <spr:DocumentCreateFilesBeginResult>
                <spr:FileIdentifier>string</spr:FileIdentifier>
                <spr:PDFFileIdentifier>string</spr:PDFFileIdentifier>
                <spr:ContentFileIdentifier>string</spr:ContentFileIdentifier>
                <spr:ChunkSize>1042</spr:ChunkSize>
            </spr:DocumentCreateFilesBeginResult>
        </spr:DocumentCreateFilesBeginResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap / DocumentCreateFilesBegin

Request XML

Response XML