Chilkat Tools

SpringCMServiceSoap12 / DocumentGetMatchByIdAndMetadata

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

#import <CkoXml.h>
#import <NSString.h>
#import <CkoHttp.h>
#import <CkoHttpResponse.h>

CkoXml *xml = [[CkoXml alloc] init];
xml.Tag = @"soap:Envelope";
[xml AddAttribute: @"xmlns:soap" value: @"http://www.w3.org/2003/05/soap-envelope"];
[xml AddAttribute: @"xmlns:spr" value: @"http://www.springcm.com/atlas/webservices/v201308/scm/"];
[xml UpdateChildContent: @"soap:Header" value: @""];
[xml UpdateChildContent: @"soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:token" value: @"string"];
[xml UpdateChildContent: @"soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:documentId" value: @"string"];
[xml UpdateChildContent: @"soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:folderId" value: @"string"];
[xml UpdateChildContent: @"soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:MustMatchMetadata" value: @"string"];
[xml UpdateChildContent: @"soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:PartialMatchMetadata" value: @"string"];
[xml UpdateChildContent: @"soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:ReturnAll" value: @"true"];
[xml UpdateChildContent: @"soap:Body|spr:DocumentGetMatchByIdAndMetadata|spr:loadExtendedMetadata" 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 = NO;
NSString *soapRequestBody = [xml GetXml];

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

CkoHttp *http = [[CkoHttp alloc] init];

[http ClearHeaders];
[http SetRequestHeader: @"Content-Type" value: contentType];
[http SetRequestHeader: @"SOAPAction" value: soapAction];

CkoHttpResponse *resp = [http PostXml: endpoint xmlDoc: soapRequestBody charset: @"utf-8"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    NSLog(@"%@",@"Failed to send SOAP request.");
    return;
}

// Get the XML response body.
CkoXml *responseXml = [[CkoXml alloc] init];
[resp GetBodyXml: responseXml];

int statusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"response status code: ",statusCode);

// If the status code does not indicate succcess, then show the response XML,
// which probably contains error information.
if (statusCode != 200) {
    NSLog(@"%@",[responseXml GetXml]);
    return;
}

NSLog(@"%@",[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).

NSString *Id = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Id"];
NSString *Name = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Name"];
NSString *ObjectType = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:ObjectType"];
NSString *ParentFolderId = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:ParentFolderId"];
NSString *CreatedBy = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:CreatedBy"];
NSString *CreatedDate = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:CreatedDate"];
NSString *UpdatedBy = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:UpdatedBy"];
NSString *UpdatedDate = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:UpdatedDate"];
NSString *Security = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Security"];
NSString *Description = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Description"];
NSString *GroupName = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName"];
NSString *FieldName = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName"];
NSString *Value = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value"];
NSString *HighValue = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue"];
NSString *ExcludeFromSearch = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch"];
NSString *SetName = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName"];
int SetNumber = [[responseXml GetChildIntValue: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber"] intValue];
NSString *DataType = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType"];
NSString *CheckedOutUserId = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:CheckedOutUserId"];
NSString *CheckedOutUserName = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:CheckedOutUserName"];
NSString *ExpirationDate = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:ExpirationDate"];
int FileSize = [[responseXml GetChildIntValue: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:FileSize"] intValue];
int PDFFileSize = [[responseXml GetChildIntValue: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:PDFFileSize"] intValue];
NSString *PDFConversion = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:PDFConversion"];
int PDFPageCount = [[responseXml GetChildIntValue: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:PDFPageCount"] intValue];
NSString *IsFormDocument = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:IsFormDocument"];
NSString *Key = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key"];
Value = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value"];
SetName = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName"];
NSString *strSetNumber = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber"];
NSString *MIMEType = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:MIMEType"];
NSString *Version = [responseXml GetChildContent: @"*:Body|*:DocumentGetMatchByIdAndMetadataResponse|*:DocumentGetMatchByIdAndMetadataResult|*:SCMDocument|*:Version"];

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:DocumentGetMatchByIdAndMetadata>
            <spr:token>string</spr:token>
            <spr:documentId>string</spr:documentId>
            <spr:folderId>string</spr:folderId>
            <spr:MustMatchMetadata>string</spr:MustMatchMetadata>
            <spr:PartialMatchMetadata>string</spr:PartialMatchMetadata>
            <spr:ReturnAll>true</spr:ReturnAll>
            <spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
        </spr:DocumentGetMatchByIdAndMetadata>
    </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:DocumentGetMatchByIdAndMetadataResponse>
            <spr:DocumentGetMatchByIdAndMetadataResult>
                <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:DocumentGetMatchByIdAndMetadataResult>
        </spr:DocumentGetMatchByIdAndMetadataResponse>
    </soap:Body>
</soap:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentGetMatchByIdAndMetadata

Request XML

Response XML