SpringCMServiceSoap / ParsePath
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
import sys
import chilkat2
xml = chilkat2.Xml()
xml.Tag = "soapenv:Envelope"
xml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
xml.AddAttribute("xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
xml.UpdateChildContent("soapenv:Header","")
xml.UpdateChildContent("soapenv:Body|spr:ParsePath|spr:token","string")
xml.UpdateChildContent("soapenv:Body|spr:ParsePath|spr:currentFolderId","string")
xml.UpdateChildContent("soapenv:Body|spr:ParsePath|spr:path","string")
xml.UpdateChildContent("soapenv:Body|spr:ParsePath|spr:loadExtendedMetadata","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
soapRequestBody = xml.GetXml()
endpoint = "https://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
soapAction = "http://www.springcm.com/atlas/webservices/v201308/scm/ParsePath"
# For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
contentType = "text/xml"
http = chilkat2.Http()
http.ClearHeaders()
http.SetRequestHeader("Content-Type",contentType)
http.SetRequestHeader("SOAPAction",soapAction)
# resp is a CkHttpResponse
resp = http.PostXml(endpoint,soapRequestBody,"utf-8")
if (http.LastMethodSuccess == False):
print(http.LastErrorText)
print("Failed to send SOAP request.")
sys.exit()
# Get the XML response body.
responseXml = chilkat2.Xml()
resp.GetBodyXml(responseXml)
statusCode = resp.StatusCode
print("response status code: " + str(statusCode))
# If the status code does not indicate succcess, then show the response XML,
# which probably contains error information.
if (statusCode != 200):
print(responseXml.GetXml())
sys.exit()
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).
Id = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Id")
Name = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Name")
ObjectType = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:ObjectType")
ParentFolderId = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:ParentFolderId")
CreatedBy = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:CreatedBy")
CreatedDate = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:CreatedDate")
UpdatedBy = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:UpdatedBy")
UpdatedDate = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:UpdatedDate")
Security = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Security")
Description = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Description")
GroupName = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Metadata|*:SCMMetadata|*:GroupName")
FieldName = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Metadata|*:SCMMetadata|*:FieldName")
Value = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Metadata|*:SCMMetadata|*:Value")
HighValue = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Metadata|*:SCMMetadata|*:HighValue")
ExcludeFromSearch = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
SetName = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Metadata|*:SCMMetadata|*:SetName")
SetNumber = responseXml.GetChildIntValue("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Metadata|*:SCMMetadata|*:SetNumber")
DataType = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Metadata|*:SCMMetadata|*:DataType")
CheckedOutUserId = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:CheckedOutUserId")
CheckedOutUserName = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:CheckedOutUserName")
ExpirationDate = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:ExpirationDate")
FileSize = responseXml.GetChildIntValue("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:FileSize")
PDFFileSize = responseXml.GetChildIntValue("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:PDFFileSize")
PDFConversion = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:PDFConversion")
PDFPageCount = responseXml.GetChildIntValue("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:PDFPageCount")
IsFormDocument = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:IsFormDocument")
Key = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:CustomFormFields|*:SCMFormField|*:Key")
Value = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:CustomFormFields|*:SCMFormField|*:Value")
SetName = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:CustomFormFields|*:SCMFormField|*:SetName")
strSetNumber = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:CustomFormFields|*:SCMFormField|*:SetNumber")
MIMEType = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:MIMEType")
Version = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Document|*:Version")
DocumentPortion = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:DocumentPortion")
Id = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Id")
Name = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Name")
ObjectType = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:ObjectType")
ParentFolderId = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:ParentFolderId")
CreatedBy = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:CreatedBy")
CreatedDate = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:CreatedDate")
UpdatedBy = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:UpdatedBy")
UpdatedDate = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:UpdatedDate")
Security = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Security")
Description = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Description")
GroupName = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Metadata|*:SCMMetadata|*:GroupName")
FieldName = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Metadata|*:SCMMetadata|*:FieldName")
Value = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Metadata|*:SCMMetadata|*:Value")
HighValue = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Metadata|*:SCMMetadata|*:HighValue")
ExcludeFromSearch = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
SetName = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Metadata|*:SCMMetadata|*:SetName")
SetNumber = responseXml.GetChildIntValue("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Metadata|*:SCMMetadata|*:SetNumber")
DataType = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:Metadata|*:SCMMetadata|*:DataType")
v_string = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Folder|*:LimitAttributeGroups|*:string")
FolderPortion = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:FolderPortion")
Result = responseXml.GetChildContent("*:Body|*:ParsePathResponse|*:ParsePathResult|*:Result")
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:ParsePath>
<spr:token>string</spr:token>
<spr:currentFolderId>string</spr:currentFolderId>
<spr:path>string</spr:path>
<spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
</spr:ParsePath>
</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:ParsePathResponse>
<spr:ParsePathResult>
<spr:Document>
<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:Document>
<spr:DocumentPortion>string</spr:DocumentPortion>
<spr:Folder>
<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:LimitAttributeGroups>
<spr:string>string</spr:string>
</spr:LimitAttributeGroups>
</spr:Folder>
<spr:FolderPortion>string</spr:FolderPortion>
<spr:Result>PathDoesNotExist</spr:Result>
</spr:ParsePathResult>
</spr:ParsePathResponse>
</soapenv:Body>
</soapenv:Envelope>