SOAP WSDL Generate Code

SpringCMServiceSoap12 / SystemFolderGetContents

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 
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, "soap:Envelope")
    CkXml::ckAddAttribute(xml,"xmlns:soap","http://www.w3.org/2003/05/soap-envelope")
    CkXml::ckAddAttribute(xml,"xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
    CkXml::ckUpdateChildContent(xml,"soap:Header","")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:SystemFolderGetContents|spr:token","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:SystemFolderGetContents|spr:systemFolder","Inbox")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:SystemFolderGetContents|spr:loadExtendedMetadata","true")
    CkXml::ckUpdateChildContentInt(xml,"soap:Body|spr:SystemFolderGetContents|spr:pager|spr:StartIndex",1042)
    CkXml::ckUpdateChildContentInt(xml,"soap:Body|spr:SystemFolderGetContents|spr:pager|spr:PageSize",1042)
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:SystemFolderGetContents|spr:pager|spr:SortColumn","Name")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:SystemFolderGetContents|spr:pager|spr:SortAscending","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::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/SystemFolderGetContents"
    ;  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|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Id")
    Name.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Name")
    ObjectType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ObjectType")
    ParentFolderId.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ParentFolderId")
    CreatedBy.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CreatedBy")
    CreatedDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CreatedDate")
    UpdatedBy.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:UpdatedBy")
    UpdatedDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:UpdatedDate")
    Security.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Security")
    Description.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Description")
    GroupName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:GroupName")
    FieldName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:FieldName")
    Value.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:Value")
    HighValue.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:HighValue")
    ExcludeFromSearch.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
    SetName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetName")
    SetNumber.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:SetNumber")
    DataType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Metadata|*:SCMMetadata|*:DataType")
    CheckedOutUserId.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CheckedOutUserId")
    CheckedOutUserName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CheckedOutUserName")
    ExpirationDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:ExpirationDate")
    FileSize.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:FileSize")
    PDFFileSize.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFFileSize")
    PDFConversion.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFConversion")
    PDFPageCount.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:PDFPageCount")
    IsFormDocument.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:IsFormDocument")
    Key.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Key")
    Value = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:Value")
    SetName = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetName")
    strSetNumber.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:CustomFormFields|*:SCMFormField|*:SetNumber")
    MIMEType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:MIMEType")
    Version.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMDocuments|*:SCMDocument|*:Version")
    Id = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Id")
    Name = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Name")
    ObjectType = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:ObjectType")
    ParentFolderId = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:ParentFolderId")
    CreatedBy = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:CreatedBy")
    CreatedDate = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:CreatedDate")
    UpdatedBy = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:UpdatedBy")
    UpdatedDate = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:UpdatedDate")
    Security = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Security")
    Description = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Description")
    GroupName = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:GroupName")
    FieldName = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:FieldName")
    Value = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:Value")
    HighValue = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:HighValue")
    ExcludeFromSearch = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
    SetName = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetName")
    SetNumber = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:SetNumber")
    DataType = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:Metadata|*:SCMMetadata|*:DataType")
    v_string.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:SCMFolders|*:SCMFolder|*:LimitAttributeGroups|*:string")
    TotalRowCount.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:SystemFolderGetContentsResponse|*:SystemFolderGetContentsResult|*:TotalRowCount")


    CkXml::ckDispose(xml)
    CkHttp::ckDispose(http)
    CkXml::ckDispose(responseXml)


    ProcedureReturn
EndProcedure
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:SystemFolderGetContents>
            <spr:token>string</spr:token>
            <spr:systemFolder>Inbox</spr:systemFolder>
            <spr:loadExtendedMetadata>true</spr:loadExtendedMetadata>
            <spr:pager>
                <spr:StartIndex>1042</spr:StartIndex>
                <spr:PageSize>1042</spr:PageSize>
                <spr:SortColumn>Name</spr:SortColumn>
                <spr:SortAscending>true</spr:SortAscending>
            </spr:pager>
        </spr:SystemFolderGetContents>
    </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:SystemFolderGetContentsResponse>
            <spr:SystemFolderGetContentsResult>
                <spr:SCMDocuments>
                    <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:SCMDocuments>
                <spr:SCMFolders>
                    <spr:SCMFolder>
                        <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:SCMFolder>
                </spr:SCMFolders>
                <spr:TotalRowCount>1042</spr:TotalRowCount>
            </spr:SystemFolderGetContentsResult>
        </spr:SystemFolderGetContentsResponse>
    </soap:Body>
</soap:Envelope>