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
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkXml.pb"
Procedure ChilkatExample()
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "soapenv:Envelope")
CkXml::ckAddAttribute(xml,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
CkXml::ckAddAttribute(xml,"xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
CkXml::ckUpdateChildContent(xml,"soapenv:Header","")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:token","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Id","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Name","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:ObjectType","Document")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:ParentFolderId","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CreatedBy","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CreatedDate","dateTime")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:UpdatedBy","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:UpdatedDate","dateTime")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Security","list of enumerated string values")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Description","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:GroupName","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:FieldName","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:Value","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:HighValue","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:SetName","string")
CkXml::ckUpdateChildContentInt(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042)
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:DataType","String")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CheckedOutUserId","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CheckedOutUserName","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:ExpirationDate","dateTime")
CkXml::ckUpdateChildContentInt(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:FileSize",123456)
CkXml::ckUpdateChildContentInt(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:PDFFileSize",123456)
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:PDFConversion","true")
CkXml::ckUpdateChildContentInt(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:PDFPageCount",1042)
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:IsFormDocument","true")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:Key","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:Value","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:SetName","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber","string")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:DocumentSave|spr:scmDocument|spr:MIMEType","string")
CkXml::ckUpdateChildContent(xml,"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.
CkXml::setCkEmitXmlDecl(xml, 0)
soapRequestBody.s = CkXml::ckGetXml(xml)
endpoint.s = "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
soapAction.s = "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"
contentType.s = "text/xml"
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttp::ckClearHeaders(http)
CkHttp::ckSetRequestHeader(http,"Content-Type",contentType)
CkHttp::ckSetRequestHeader(http,"SOAPAction",soapAction)
resp.i = CkHttp::ckPostXml(http,endpoint,soapRequestBody,"utf-8")
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
Debug "Failed to send SOAP request."
CkXml::ckDispose(xml)
CkHttp::ckDispose(http)
ProcedureReturn
EndIf
; Get the XML response body.
responseXml.i = CkXml::ckCreate()
If responseXml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodyXml(resp,responseXml)
statusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "response status code: " + Str(statusCode)
CkHttpResponse::ckDispose(resp)
; If the status code does not indicate succcess, then show the response XML,
; which probably contains error information.
If statusCode <> 200
Debug CkXml::ckGetXml(responseXml)
CkXml::ckDispose(xml)
CkHttp::ckDispose(http)
CkXml::ckDispose(responseXml)
ProcedureReturn
EndIf
Debug CkXml::ckGetXml(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).
Id.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Id")
Name.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Name")
ObjectType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:ObjectType")
ParentFolderId.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:ParentFolderId")
CreatedBy.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CreatedBy")
CreatedDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CreatedDate")
UpdatedBy.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:UpdatedBy")
UpdatedDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:UpdatedDate")
Security.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Security")
Description.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Description")
GroupName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:GroupName")
FieldName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:FieldName")
Value.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:Value")
HighValue.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:HighValue")
ExcludeFromSearch.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
SetName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:SetName")
SetNumber.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:SetNumber")
DataType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Metadata|*:SCMMetadata|*:DataType")
CheckedOutUserId.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CheckedOutUserId")
CheckedOutUserName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CheckedOutUserName")
ExpirationDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:ExpirationDate")
FileSize.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:FileSize")
PDFFileSize.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:PDFFileSize")
PDFConversion.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:PDFConversion")
PDFPageCount.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:PDFPageCount")
IsFormDocument.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:IsFormDocument")
Key.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CustomFormFields|*:SCMFormField|*:Key")
Value = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CustomFormFields|*:SCMFormField|*:Value")
SetName = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CustomFormFields|*:SCMFormField|*:SetName")
strSetNumber.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:CustomFormFields|*:SCMFormField|*:SetNumber")
MIMEType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:MIMEType")
Version.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentSaveResponse|*:DocumentSaveResult|*:Version")
CkXml::ckDispose(xml)
CkHttp::ckDispose(http)
CkXml::ckDispose(responseXml)
ProcedureReturn
EndProcedure