SpringCMServiceSoap12 / GetDocumentRevisions
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
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoXml
Boolean iSuccess
String sSoapRequestBody
String sEndpoint
String sSoapAction
String sContentType
Handle hoHttp
Variant vResp
Handle hoResp
Variant vResponseXml
Handle hoResponseXml
Integer iStatusCode
String sId
String sName
String sObjectType
String sParentFolderId
String sCreatedBy
String sCreatedDate
String sUpdatedBy
String sUpdatedDate
String sSecurity
String sDescription
String sGroupName
String sFieldName
String sValue
String sHighValue
String sExcludeFromSearch
String sSetName
Integer iSetNumber
String sDataType
String sCheckedOutUserId
String sCheckedOutUserName
String sExpirationDate
Integer iFileSize
Integer iPDFFileSize
String sPDFConversion
Integer iPDFPageCount
String sIsFormDocument
String sKey
String sStrSetNumber
String sMIMEType
String sVersion
String sTemp1
Boolean bTemp1
Get Create (RefClass(cComChilkatXml)) To hoXml
If (Not(IsComObjectCreated(hoXml))) Begin
Send CreateComObject of hoXml
End
Set ComTag Of hoXml To "soap:Envelope"
Get ComAddAttribute Of hoXml "xmlns:soap" "http://www.w3.org/2003/05/soap-envelope" To iSuccess
Get ComAddAttribute Of hoXml "xmlns:spr" "http://www.springcm.com/atlas/webservices/v201308/scm/" To iSuccess
Send ComUpdateChildContent To hoXml "soap:Header" ""
Send ComUpdateChildContent To hoXml "soap:Body|spr:GetDocumentRevisions|spr:token" "string"
Send ComUpdateChildContent To hoXml "soap:Body|spr:GetDocumentRevisions|spr:documentUid" "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.
Set ComEmitXmlDecl Of hoXml To False
Get ComGetXml Of hoXml To sSoapRequestBody
Move "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx" To sEndpoint
Move "http://www.springcm.com/atlas/webservices/v201308/scm/GetDocumentRevisions" To sSoapAction
// For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
Move "text/xml" To sContentType
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComClearHeaders To hoHttp
Send ComSetRequestHeader To hoHttp "Content-Type" sContentType
Send ComSetRequestHeader To hoHttp "SOAPAction" sSoapAction
Get ComPostXml Of hoHttp sEndpoint sSoapRequestBody "utf-8" To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed to send SOAP request."
Procedure_Return
End
// Get the XML response body.
Get Create (RefClass(cComChilkatXml)) To hoResponseXml
If (Not(IsComObjectCreated(hoResponseXml))) Begin
Send CreateComObject of hoResponseXml
End
Get pvComObject of hoResponseXml to vResponseXml
Get ComGetBodyXml Of hoResp vResponseXml To iSuccess
Get ComStatusCode Of hoResp To iStatusCode
Showln "response status code: " iStatusCode
Send Destroy of hoResp
// If the status code does not indicate succcess, then show the response XML,
// which probably contains error information.
If (iStatusCode <> 200) Begin
Get ComGetXml Of hoResponseXml To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComGetXml Of hoResponseXml To sTemp1
Showln sTemp1
// 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).
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Id" To sId
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Name" To sName
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:ObjectType" To sObjectType
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:ParentFolderId" To sParentFolderId
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:CreatedBy" To sCreatedBy
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:CreatedDate" To sCreatedDate
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:UpdatedBy" To sUpdatedBy
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:UpdatedDate" To sUpdatedDate
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Security" To sSecurity
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Description" To sDescription
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName" To sGroupName
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName" To sFieldName
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value" To sValue
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue" To sHighValue
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch" To sExcludeFromSearch
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName" To sSetName
Get ComGetChildIntValue Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber" To iSetNumber
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType" To sDataType
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:CheckedOutUserId" To sCheckedOutUserId
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:CheckedOutUserName" To sCheckedOutUserName
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:ExpirationDate" To sExpirationDate
Get ComGetChildIntValue Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:FileSize" To iFileSize
Get ComGetChildIntValue Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:PDFFileSize" To iPDFFileSize
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:PDFConversion" To sPDFConversion
Get ComGetChildIntValue Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:PDFPageCount" To iPDFPageCount
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:IsFormDocument" To sIsFormDocument
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key" To sKey
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value" To sValue
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName" To sSetName
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber" To sStrSetNumber
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:MIMEType" To sMIMEType
Get ComGetChildContent Of hoResponseXml "*:Body|*:GetDocumentRevisionsResponse|*:GetDocumentRevisionsResult|*:SCMDocument|*:Version" To sVersion
End_Procedure
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:GetDocumentRevisions>
<spr:token>string</spr:token>
<spr:documentUid>string</spr:documentUid>
</spr:GetDocumentRevisions>
</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:GetDocumentRevisionsResponse>
<spr:GetDocumentRevisionsResult>
<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:GetDocumentRevisionsResult>
</spr:GetDocumentRevisionsResponse>
</soap:Body>
</soap:Envelope>