Chilkat Tools

SpringCMServiceSoap / DocumentCreateCommit

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

<?php

include("chilkat_9_5_0.php");

$xml = new CkXml();
$xml->put_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:DocumentCreateCommit|spr:token','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:fileIdentifier','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Id','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Name','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:ObjectType','Document');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:ParentFolderId','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:CreatedBy','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:CreatedDate','dateTime');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:UpdatedBy','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:UpdatedDate','dateTime');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Security','list of enumerated string values');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Description','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:GroupName','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:FieldName','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:Value','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:HighValue','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch','true');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:SetName','string');
$xml->UpdateChildContentInt('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:SetNumber',1042);
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:DataType','String');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:CheckedOutUserId','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:CheckedOutUserName','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:ExpirationDate','dateTime');
$xml->UpdateChildContentInt('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:FileSize',123456);
$xml->UpdateChildContentInt('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:PDFFileSize',123456);
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:PDFConversion','true');
$xml->UpdateChildContentInt('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:PDFPageCount',1042);
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:IsFormDocument','true');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:Key','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:Value','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:SetName','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:MIMEType','string');
$xml->UpdateChildContent('soapenv:Body|spr:DocumentCreateCommit|spr:scmDocument|spr:Version','string');

// 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/DocumentCreateCommit';
//  For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
$contentType = 'text/xml';

$http = new CkHttp();

$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;
}

// Get the XML response body.
$responseXml = new CkXml();
$resp->GetBodyXml($responseXml);

$statusCode = $resp->get_StatusCode();
print 'response status code: ' . $statusCode . "\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;
}

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|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Id');
$Name = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Name');
$ObjectType = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:ObjectType');
$ParentFolderId = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:ParentFolderId');
$CreatedBy = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:CreatedBy');
$CreatedDate = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:CreatedDate');
$UpdatedBy = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:UpdatedBy');
$UpdatedDate = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:UpdatedDate');
$Security = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Security');
$Description = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Description');
$GroupName = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Metadata|*:SCMMetadata|*:GroupName');
$FieldName = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Metadata|*:SCMMetadata|*:FieldName');
$Value = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Metadata|*:SCMMetadata|*:Value');
$HighValue = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Metadata|*:SCMMetadata|*:HighValue');
$ExcludeFromSearch = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch');
$SetName = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Metadata|*:SCMMetadata|*:SetName');
$SetNumber = $responseXml->GetChildIntValue('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Metadata|*:SCMMetadata|*:SetNumber');
$DataType = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Metadata|*:SCMMetadata|*:DataType');
$CheckedOutUserId = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:CheckedOutUserId');
$CheckedOutUserName = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:CheckedOutUserName');
$ExpirationDate = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:ExpirationDate');
$FileSize = $responseXml->GetChildIntValue('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:FileSize');
$PDFFileSize = $responseXml->GetChildIntValue('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:PDFFileSize');
$PDFConversion = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:PDFConversion');
$PDFPageCount = $responseXml->GetChildIntValue('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:PDFPageCount');
$IsFormDocument = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:IsFormDocument');
$Key = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:CustomFormFields|*:SCMFormField|*:Key');
$Value = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:CustomFormFields|*:SCMFormField|*:Value');
$SetName = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:CustomFormFields|*:SCMFormField|*:SetName');
$strSetNumber = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:CustomFormFields|*:SCMFormField|*:SetNumber');
$MIMEType = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:MIMEType');
$Version = $responseXml->getChildContent('*:Body|*:DocumentCreateCommitResponse|*:DocumentCreateCommitResult|*:Version');

?>

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:DocumentCreateCommit>
            <spr:token>string</spr:token>
            <spr:fileIdentifier>string</spr:fileIdentifier>
            <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:DocumentCreateCommit>
    </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:DocumentCreateCommitResponse>
            <spr:DocumentCreateCommitResult>
                <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:DocumentCreateCommitResult>
        </spr:DocumentCreateCommitResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap / DocumentCreateCommit

Request XML

Response XML