SpringCMServiceSoap / 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
func chilkatTest() {
let xml = CkoXml()
xml.Tag = "soapenv:Envelope"
xml.AddAttribute("xmlns:soapenv", value: "http://schemas.xmlsoap.org/soap/envelope/")
xml.AddAttribute("xmlns:spr", value: "http://www.springcm.com/atlas/webservices/v201308/scm/")
xml.UpdateChildContent("soapenv:Header", value: "")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:token", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Id", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Name", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:ObjectType", value: "Document")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:ParentFolderId", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:CreatedBy", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:CreatedDate", value: "dateTime")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:UpdatedBy", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:UpdatedDate", value: "dateTime")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Security", value: "list of enumerated string values")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Description", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:GroupName", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:FieldName", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:Value", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:HighValue", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch", value: "true")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:SetName", value: "string")
xml.UpdateChildContentInt("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:SetNumber", value: 1042)
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Metadata|spr:SCMMetadata|spr:DataType", value: "String")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:CheckedOutUserId", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:CheckedOutUserName", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:ExpirationDate", value: "dateTime")
xml.UpdateChildContentInt("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:FileSize", value: 123456)
xml.UpdateChildContentInt("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:PDFFileSize", value: 123456)
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:PDFConversion", value: "true")
xml.UpdateChildContentInt("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:PDFPageCount", value: 1042)
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:IsFormDocument", value: "true")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:CustomFormFields|spr:SCMFormField|spr:Key", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:CustomFormFields|spr:SCMFormField|spr:Value", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:CustomFormFields|spr:SCMFormField|spr:SetName", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:MIMEType", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:doc|spr:Version", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:message", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:emails", value: "string")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:writtenRequired", value: "true")
xml.UpdateChildContent("soapenv:Body|spr:DocumentSendForSignature|spr:senderSignsToo", value: "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.EmitXmlDecl = false
var soapRequestBody: String? = xml.GetXml()
var endpoint: String? = "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
var soapAction: String? = "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"
var contentType: String? = "text/xml"
let http = CkoHttp()
http.ClearHeaders()
http.SetRequestHeader("Content-Type", value: contentType)
http.SetRequestHeader("SOAPAction", value: soapAction)
var resp: CkoHttpResponse? = http.PostXml(endpoint, xmlDoc: soapRequestBody, charset: "utf-8")
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
print("Failed to send SOAP request.")
return
}
// Get the XML response body.
let responseXml = CkoXml()
resp!.GetBodyXml(responseXml)
var statusCode: Int = resp!.StatusCode.intValue
print("response status code: \(statusCode)")
resp = nil
// If the status code does not indicate succcess, then show the response XML,
// which probably contains error information.
if statusCode != 200 {
print("\(responseXml.GetXml())")
return
}
print("\(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).
}
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: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>
</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:DocumentSendForSignatureResponse/>
</soapenv:Body>
</soapenv:Envelope>