Chilkat Tools

SpringCMServiceSoap12 / DocumentSendForSignature

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

$oXml = ObjCreate("Chilkat_9_5_0.Xml")
$oXml.Tag = "soap:Envelope"
$oXml.AddAttribute("xmlns:soap","http://www.w3.org/2003/05/soap-envelope")
$oXml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
$oXml.UpdateChildContent "soap:Header",""
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:token","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Id","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Name","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:ObjectType","Document"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:ParentFolderId","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:CreatedBy","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:CreatedDate","dateTime"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:UpdatedBy","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:UpdatedDate","dateTime"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Security","list of enumerated string values"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Description","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:GroupName","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:FieldName","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:Value","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:HighValue","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:SetName","string"
$oXml.UpdateChildContentInt "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:DataType","String"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:CheckedOutUserId","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:CheckedOutUserName","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:ExpirationDate","dateTime"
$oXml.UpdateChildContentInt "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:FileSize",123456
$oXml.UpdateChildContentInt "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:PDFFileSize",123456
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:PDFConversion","true"
$oXml.UpdateChildContentInt "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:PDFPageCount",1042
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:IsFormDocument","true"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:CustomFormFields|spr:SCMFormField|spr:Key","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:CustomFormFields|spr:SCMFormField|spr:Value","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:CustomFormFields|spr:SCMFormField|spr:SetName","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:MIMEType","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:doc|spr:Version","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:message","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:emails","string"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:writtenRequired","true"
$oXml.UpdateChildContent "soap:Body|spr:DocumentSendForSignature|spr:senderSignsToo","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. 
$oXml.EmitXmlDecl = False
Local $soapRequestBody = $oXml.GetXml()

Local $sEndpoint = "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
Local $soapAction = "http://www.springcm.com/atlas/webservices/v201308/scm/DocumentSendForSignature"
;  For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
Local $sContentType = "text/xml"

$oHttp = ObjCreate("Chilkat_9_5_0.Http")

$oHttp.ClearHeaders 
$oHttp.SetRequestHeader "Content-Type",$sContentType
$oHttp.SetRequestHeader "SOAPAction",$soapAction

Local $oResp = $oHttp.PostXml($sEndpoint,$soapRequestBody,"utf-8")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    ConsoleWrite("Failed to send SOAP request." & @CRLF)
    Exit
EndIf

; Get the XML response body.
$oResponseXml = ObjCreate("Chilkat_9_5_0.Xml")
$oResp.GetBodyXml($oResponseXml)

Local $iStatusCode = $oResp.StatusCode
ConsoleWrite("response status code: " & $iStatusCode & @CRLF)

; If the status code does not indicate succcess, then show the response XML,
; which probably contains error information.
If ($iStatusCode <> 200) Then
    ConsoleWrite($oResponseXml.GetXml() & @CRLF)
    Exit
EndIf

ConsoleWrite($oResponseXml.GetXml() & @CRLF)

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

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:DocumentSendForSignature>
            <spr:token>string</spr:token>
            <spr:doc>
                <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:doc>
            <spr:message>string</spr:message>
            <spr:emails>string</spr:emails>
            <spr:writtenRequired>true</spr:writtenRequired>
            <spr:senderSignsToo>true</spr:senderSignsToo>
        </spr:DocumentSendForSignature>
    </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:DocumentSendForSignatureResponse/>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentSendForSignature

Request XML

Response XML