Chilkat Tools

SpringCMServiceSoap / DocumentCreateFilesBegin

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

    xml := chilkat.NewXml()
    xml.SetTag("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:DocumentCreateFilesBegin|spr:token","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Id","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Name","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:ObjectType","Document")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:ParentFolderId","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CreatedBy","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CreatedDate","dateTime")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:UpdatedBy","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:UpdatedDate","dateTime")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Security","list of enumerated string values")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Description","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:GroupName","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:FieldName","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:Value","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:HighValue","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:ExcludeFromSearch","true")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:SetName","string")
    xml.UpdateChildContentInt("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:SetNumber",1042)
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Metadata|spr:SCMMetadata|spr:DataType","String")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CheckedOutUserId","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CheckedOutUserName","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:ExpirationDate","dateTime")
    xml.UpdateChildContentInt("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:FileSize",123456)
    xml.UpdateChildContentInt("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:PDFFileSize",123456)
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:PDFConversion","true")
    xml.UpdateChildContentInt("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:PDFPageCount",1042)
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:IsFormDocument","true")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CustomFormFields|spr:SCMFormField|spr:Key","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CustomFormFields|spr:SCMFormField|spr:Value","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CustomFormFields|spr:SCMFormField|spr:SetName","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:CustomFormFields|spr:SCMFormField|spr:SetNumber","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:MIMEType","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:document|spr:Version","string")
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:md5Hash","BqozVXeZZg==")
    xml.UpdateChildContentInt("soapenv:Body|spr:DocumentCreateFilesBegin|spr:pdfFileSize",123456)
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:pdfMd5Hash","BqozVXeZZg==")
    xml.UpdateChildContentInt("soapenv:Body|spr:DocumentCreateFilesBegin|spr:contentFileSize",123456)
    xml.UpdateChildContent("soapenv:Body|spr:DocumentCreateFilesBegin|spr:contentMd5Hash","BqozVXeZZg==")

    // 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.SetEmitXmlDecl(false)
    soapRequestBody := xml.GetXml()

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

    http := chilkat.NewHttp()

    http.ClearHeaders()
    http.SetRequestHeader("Content-Type",contentType)
    http.SetRequestHeader("SOAPAction",soapAction)

    resp := http.PostXml(endpoint,*soapRequestBody,"utf-8")
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        fmt.Println("Failed to send SOAP request.")
        xml.DisposeXml()
        http.DisposeHttp()
        return
    }

    // Get the XML response body.
    responseXml := chilkat.NewXml()
    resp.GetBodyXml(responseXml)

    statusCode := resp.StatusCode()
    fmt.Println("response status code: ", statusCode)

    resp.DisposeHttpResponse()

    // If the status code does not indicate succcess, then show the response XML,
    // which probably contains error information.
    if statusCode != 200 {
        fmt.Println(*responseXml.GetXml())
        xml.DisposeXml()
        http.DisposeHttp()
        responseXml.DisposeXml()
        return
    }

    fmt.Println(*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).

    FileIdentifier := responseXml.GetChildContent("*:Body|*:DocumentCreateFilesBeginResponse|*:DocumentCreateFilesBeginResult|*:FileIdentifier")
    PDFFileIdentifier := responseXml.GetChildContent("*:Body|*:DocumentCreateFilesBeginResponse|*:DocumentCreateFilesBeginResult|*:PDFFileIdentifier")
    ContentFileIdentifier := responseXml.GetChildContent("*:Body|*:DocumentCreateFilesBeginResponse|*:DocumentCreateFilesBeginResult|*:ContentFileIdentifier")
    ChunkSize := responseXml.GetChildIntValue("*:Body|*:DocumentCreateFilesBeginResponse|*:DocumentCreateFilesBeginResult|*:ChunkSize")

    xml.DisposeXml()
    http.DisposeHttp()
    responseXml.DisposeXml()

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:DocumentCreateFilesBegin>
            <spr:token>string</spr:token>
            <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:md5Hash>BqozVXeZZg==</spr:md5Hash>
            <spr:pdfFileSize>123456</spr:pdfFileSize>
            <spr:pdfMd5Hash>BqozVXeZZg==</spr:pdfMd5Hash>
            <spr:contentFileSize>123456</spr:contentFileSize>
            <spr:contentMd5Hash>BqozVXeZZg==</spr:contentMd5Hash>
        </spr:DocumentCreateFilesBegin>
    </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:DocumentCreateFilesBeginResponse>
            <spr:DocumentCreateFilesBeginResult>
                <spr:FileIdentifier>string</spr:FileIdentifier>
                <spr:PDFFileIdentifier>string</spr:PDFFileIdentifier>
                <spr:ContentFileIdentifier>string</spr:ContentFileIdentifier>
                <spr:ChunkSize>1042</spr:ChunkSize>
            </spr:DocumentCreateFilesBeginResult>
        </spr:DocumentCreateFilesBeginResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap / DocumentCreateFilesBegin

Request XML

Response XML