Chilkat Tools

SpringCMServiceSoap / FolderGetById

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

var
xml: HCkXml;
soapRequestBody: PWideChar;
endpoint: PWideChar;
soapAction: PWideChar;
contentType: PWideChar;
http: HCkHttp;
resp: HCkHttpResponse;
responseXml: HCkXml;
statusCode: Integer;
Id: PWideChar;
Name: PWideChar;
ObjectType: PWideChar;
ParentFolderId: PWideChar;
CreatedBy: PWideChar;
CreatedDate: PWideChar;
UpdatedBy: PWideChar;
UpdatedDate: PWideChar;
Security: PWideChar;
Description: PWideChar;
GroupName: PWideChar;
FieldName: PWideChar;
Value: PWideChar;
HighValue: PWideChar;
ExcludeFromSearch: PWideChar;
SetName: PWideChar;
SetNumber: Integer;
DataType: PWideChar;
v_string: PWideChar;

begin
xml := CkXml_Create();
CkXml_putTag(xml,'soapenv:Envelope');
CkXml_AddAttribute(xml,'xmlns:soapenv','http://schemas.xmlsoap.org/soap/envelope/');
CkXml_AddAttribute(xml,'xmlns:spr','http://www.springcm.com/atlas/webservices/v201308/scm/');
CkXml_UpdateChildContent(xml,'soapenv:Header','');
CkXml_UpdateChildContent(xml,'soapenv:Body|spr:FolderGetById|spr:token','string');
CkXml_UpdateChildContent(xml,'soapenv:Body|spr:FolderGetById|spr:folderId','string');
CkXml_UpdateChildContent(xml,'soapenv:Body|spr:FolderGetById|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. 
CkXml_putEmitXmlDecl(xml,False);
soapRequestBody := CkXml__getXml(xml);

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

http := CkHttp_Create();

CkHttp_ClearHeaders(http);
CkHttp_SetRequestHeader(http,'Content-Type',contentType);
CkHttp_SetRequestHeader(http,'SOAPAction',soapAction);

resp := CkHttp_PostXml(http,endpoint,soapRequestBody,'utf-8');
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Memo1.Lines.Add('Failed to send SOAP request.');
    Exit;
  end;

// Get the XML response body.
responseXml := CkXml_Create();
CkHttpResponse_GetBodyXml(resp,responseXml);

statusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('response status code: ' + IntToStr(statusCode));

CkHttpResponse_Dispose(resp);

// If the status code does not indicate succcess, then show the response XML,
// which probably contains error information.
if (statusCode <> 200) then
  begin
    Memo1.Lines.Add(CkXml__getXml(responseXml));
    Exit;
  end;

Memo1.Lines.Add(CkXml__getXml(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 := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Id');
Name := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Name');
ObjectType := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:ObjectType');
ParentFolderId := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:ParentFolderId');
CreatedBy := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:CreatedBy');
CreatedDate := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:CreatedDate');
UpdatedBy := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:UpdatedBy');
UpdatedDate := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:UpdatedDate');
Security := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Security');
Description := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Description');
GroupName := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Metadata|*:SCMMetadata|*:GroupName');
FieldName := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Metadata|*:SCMMetadata|*:FieldName');
Value := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Metadata|*:SCMMetadata|*:Value');
HighValue := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Metadata|*:SCMMetadata|*:HighValue');
ExcludeFromSearch := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch');
SetName := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Metadata|*:SCMMetadata|*:SetName');
SetNumber := CkXml_GetChildIntValue(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Metadata|*:SCMMetadata|*:SetNumber');
DataType := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:Metadata|*:SCMMetadata|*:DataType');
v_string := CkXml__getChildContent(responseXml,'*:Body|*:FolderGetByIdResponse|*:FolderGetByIdResult|*:LimitAttributeGroups|*:string');

CkXml_Dispose(xml);
CkHttp_Dispose(http);
CkXml_Dispose(responseXml);

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:FolderGetById>
            <spr:token>string</spr:token>
            <spr:folderId>string</spr:folderId>
            <spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
        </spr:FolderGetById>
    </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:FolderGetByIdResponse>
            <spr:FolderGetByIdResult>
                <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:FolderGetByIdResult>
        </spr:FolderGetByIdResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap / FolderGetById

Request XML

Response XML