SOAP WSDL Generate Code

SpringCMServiceSoap12 / DocumentCreateFilesCommit

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:DocumentCreateFilesCommit|spr:token","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:identifiers|spr:FileIdentifier","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:identifiers|spr:PDFFileIdentifier","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:identifiers|spr:ContentFileIdentifier","string")
    CkXml::ckUpdateChildContentInt(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:identifiers|spr:ChunkSize",1042)
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Id","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Name","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:ObjectType","Document")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:ParentFolderId","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:CreatedBy","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:CreatedDate","dateTime")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:UpdatedBy","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:UpdatedDate","dateTime")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Security","list of enumerated string values")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Description","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:GroupName","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:FieldName","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:Value","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:HighValue","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:SetName","string")
    CkXml::ckUpdateChildContentInt(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042)
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Metadata|spr:SCMMetadata|spr:DataType","String")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:CheckedOutUserId","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:CheckedOutUserName","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:ExpirationDate","dateTime")
    CkXml::ckUpdateChildContentInt(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:FileSize",123456)
    CkXml::ckUpdateChildContentInt(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:PDFFileSize",123456)
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:PDFConversion","true")
    CkXml::ckUpdateChildContentInt(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:PDFPageCount",1042)
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:IsFormDocument","true")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:Key","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:Value","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:SetName","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:MIMEType","string")
    CkXml::ckUpdateChildContent(xml,"soap:Body|spr:DocumentCreateFilesCommit|spr:scmDocument|spr:Version","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. 
    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/DocumentCreateFilesCommit"
    ;  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|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Id")
    Name.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Name")
    ObjectType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:ObjectType")
    ParentFolderId.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:ParentFolderId")
    CreatedBy.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:CreatedBy")
    CreatedDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:CreatedDate")
    UpdatedBy.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:UpdatedBy")
    UpdatedDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:UpdatedDate")
    Security.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Security")
    Description.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Description")
    GroupName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Metadata|*:SCMMetadata|*:GroupName")
    FieldName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Metadata|*:SCMMetadata|*:FieldName")
    Value.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Metadata|*:SCMMetadata|*:Value")
    HighValue.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Metadata|*:SCMMetadata|*:HighValue")
    ExcludeFromSearch.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Metadata|*:SCMMetadata|*:ExcludeFromSearch")
    SetName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Metadata|*:SCMMetadata|*:SetName")
    SetNumber.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Metadata|*:SCMMetadata|*:SetNumber")
    DataType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Metadata|*:SCMMetadata|*:DataType")
    CheckedOutUserId.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:CheckedOutUserId")
    CheckedOutUserName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:CheckedOutUserName")
    ExpirationDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:ExpirationDate")
    FileSize.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:FileSize")
    PDFFileSize.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:PDFFileSize")
    PDFConversion.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:PDFConversion")
    PDFPageCount.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:PDFPageCount")
    IsFormDocument.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:IsFormDocument")
    Key.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:CustomFormFields|*:SCMFormField|*:Key")
    Value = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:CustomFormFields|*:SCMFormField|*:Value")
    SetName = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:CustomFormFields|*:SCMFormField|*:SetName")
    strSetNumber.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:CustomFormFields|*:SCMFormField|*:SetNumber")
    MIMEType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:MIMEType")
    Version.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:DocumentCreateFilesCommitResponse|*:DocumentCreateFilesCommitResult|*:Version")


    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:DocumentCreateFilesCommit>
            <spr:token>string</spr:token>
            <spr:identifiers>
                <spr:FileIdentifier>string</spr:FileIdentifier>
                <spr:PDFFileIdentifier>string</spr:PDFFileIdentifier>
                <spr:ContentFileIdentifier>string</spr:ContentFileIdentifier>
                <spr:ChunkSize>1042</spr:ChunkSize>
            </spr:identifiers>
            <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:DocumentCreateFilesCommit>
    </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:DocumentCreateFilesCommitResponse>
            <spr:DocumentCreateFilesCommitResult>
                <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:DocumentCreateFilesCommitResult>
        </spr:DocumentCreateFilesCommitResponse>
    </soap:Body>
</soap:Envelope>