Chilkat Tools

SpringCMServiceSoap / DocumentSave

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

integer li_rc
oleobject loo_Xml
string ls_SoapRequestBody
string ls_Endpoint
string ls_SoapAction
string ls_ContentType
oleobject loo_Http
oleobject loo_Resp
oleobject loo_ResponseXml
integer li_StatusCode
string ls_Id
string ls_Name
string ls_ObjectType
string ls_ParentFolderId
string ls_CreatedBy
string ls_CreatedDate
string ls_UpdatedBy
string ls_UpdatedDate
string ls_Security
string ls_Description
string ls_GroupName
string ls_FieldName
string ls_Value
string ls_HighValue
string ls_ExcludeFromSearch
string ls_SetName
integer li_SetNumber
string ls_DataType
string ls_CheckedOutUserId
string ls_CheckedOutUserName
string ls_ExpirationDate
integer li_FileSize
integer li_PDFFileSize
string ls_PDFConversion
integer li_PDFPageCount
string ls_IsFormDocument
string ls_Key
string ls_StrSetNumber
string ls_MIMEType
string ls_Version

loo_Xml = create oleobject
li_rc = loo_Xml.ConnectToNewObject("Chilkat_9_5_0.Xml")
if li_rc < 0 then
    destroy loo_Xml
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_Xml.Tag = "soapenv:Envelope"
loo_Xml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
loo_Xml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
loo_Xml.UpdateChildContent("soapenv:Header","")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:token","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Id","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Name","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:ObjectType","Document")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:ParentFolderId","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CreatedBy","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CreatedDate","dateTime")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:UpdatedBy","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:UpdatedDate","dateTime")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Security","list of enumerated string values")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Description","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:GroupName","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:FieldName","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:Value","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:HighValue","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:SetName","string")
loo_Xml.UpdateChildContentInt("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042)
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:DataType","String")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CheckedOutUserId","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CheckedOutUserName","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:ExpirationDate","dateTime")
loo_Xml.UpdateChildContentInt("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:FileSize",123456)
loo_Xml.UpdateChildContentInt("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:PDFFileSize",123456)
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:PDFConversion","true")
loo_Xml.UpdateChildContentInt("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:PDFPageCount",1042)
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:IsFormDocument","true")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:Key","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:Value","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:SetName","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:MIMEType","string")
loo_Xml.UpdateChildContent("soapenv:Body|spr:DocumentSave|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. 
loo_Xml.EmitXmlDecl = 0
ls_SoapRequestBody = loo_Xml.GetXml()

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")

loo_Http.ClearHeaders()
loo_Http.SetRequestHeader("Content-Type",ls_ContentType)
loo_Http.SetRequestHeader("SOAPAction",ls_SoapAction)

loo_Resp = loo_Http.PostXml(ls_Endpoint,ls_SoapRequestBody,"utf-8")
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    Write-Debug "Failed to send SOAP request."
    destroy loo_Xml
    destroy loo_Http
    return
end if

// Get the XML response body.
loo_ResponseXml = create oleobject
li_rc = loo_ResponseXml.ConnectToNewObject("Chilkat_9_5_0.Xml")

loo_Resp.GetBodyXml(loo_ResponseXml)

li_StatusCode = loo_Resp.StatusCode
Write-Debug "response status code: " + string(li_StatusCode)

destroy loo_Resp

// If the status code does not indicate succcess, then show the response XML,
// which probably contains error information.
if li_StatusCode <> 200 then
    Write-Debug loo_ResponseXml.GetXml()
    destroy loo_Xml
    destroy loo_Http
    destroy loo_ResponseXml
    return
end if

Write-Debug loo_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).

ls_Id = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Id")
ls_Name = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Name")
ls_ObjectType = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:ObjectType")
ls_ParentFolderId = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:ParentFolderId")
ls_CreatedBy = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CreatedBy")
ls_CreatedDate = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CreatedDate")
ls_UpdatedBy = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:UpdatedBy")
ls_UpdatedDate = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:UpdatedDate")
ls_Security = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Security")
ls_Description = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Description")
ls_GroupName = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:GroupName")
ls_FieldName = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:FieldName")
ls_Value = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:Value")
ls_HighValue = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:HighValue")
ls_ExcludeFromSearch = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
ls_SetName = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:SetName")
li_SetNumber = loo_ResponseXml.GetChildIntValue("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:SetNumber")
ls_DataType = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:DataType")
ls_CheckedOutUserId = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CheckedOutUserId")
ls_CheckedOutUserName = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CheckedOutUserName")
ls_ExpirationDate = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:ExpirationDate")
li_FileSize = loo_ResponseXml.GetChildIntValue("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:FileSize")
li_PDFFileSize = loo_ResponseXml.GetChildIntValue("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:PDFFileSize")
ls_PDFConversion = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:PDFConversion")
li_PDFPageCount = loo_ResponseXml.GetChildIntValue("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:PDFPageCount")
ls_IsFormDocument = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:IsFormDocument")
ls_Key = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CustomFormFields|*:SCMFormField|*:Key")
ls_Value = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CustomFormFields|*:SCMFormField|*:Value")
ls_SetName = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CustomFormFields|*:SCMFormField|*:SetName")
ls_StrSetNumber = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CustomFormFields|*:SCMFormField|*:SetNumber")
ls_MIMEType = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:MIMEType")
ls_Version = loo_ResponseXml.GetChildContent("*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Version")


destroy loo_Xml
destroy loo_Http
destroy loo_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:DocumentSave>
            <spr:token>string</spr:token>
            <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:DocumentSave>
    </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:DocumentSaveResponse>
            <spr:DocumentSaveResult>
                <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:DocumentSaveResult>
        </spr:DocumentSaveResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap / DocumentSave

Request XML

Response XML