IndexUploadService

Click here for a complete list of operations.

StartFtpSession

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /sterlingvdr.sterlingwebservice/indexuploadservice.asmx HTTP/1.1
Host: vdr.sterlingdatarooms.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://sterlingfp.com/StartFtpSession"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <StartFtpSession xmlns="http://sterlingfp.com/">
      <authToken>string</authToken>
      <metadataXML>string</metadataXML>
      <uploadType>int</uploadType>
      <version>string</version>
      <domainId>int</domainId>
    </StartFtpSession>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <StartFtpSessionResponse xmlns="http://sterlingfp.com/">
      <StartFtpSessionResult>
        <SessionId>string</SessionId>
        <UploadedSize>long</UploadedSize>
        <Status>NEW or UPLOADED or PROCESSING or COMPLETE or CANCELLED or ERROR or READY or UNZIPPING or UNZIPPED</Status>
        <DataFilePath>string</DataFilePath>
        <SessionPath>string</SessionPath>
        <FtpUserName>string</FtpUserName>
        <FtpPassword>string</FtpPassword>
        <FtpIPAddress>string</FtpIPAddress>
        <Version>string</Version>
        <DomainId>int</DomainId>
        <isManualConverstion>int</isManualConverstion>
      </StartFtpSessionResult>
    </StartFtpSessionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /sterlingvdr.sterlingwebservice/indexuploadservice.asmx HTTP/1.1
Host: vdr.sterlingdatarooms.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <StartFtpSession xmlns="http://sterlingfp.com/">
      <authToken>string</authToken>
      <metadataXML>string</metadataXML>
      <uploadType>int</uploadType>
      <version>string</version>
      <domainId>int</domainId>
    </StartFtpSession>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <StartFtpSessionResponse xmlns="http://sterlingfp.com/">
      <StartFtpSessionResult>
        <SessionId>string</SessionId>
        <UploadedSize>long</UploadedSize>
        <Status>NEW or UPLOADED or PROCESSING or COMPLETE or CANCELLED or ERROR or READY or UNZIPPING or UNZIPPED</Status>
        <DataFilePath>string</DataFilePath>
        <SessionPath>string</SessionPath>
        <FtpUserName>string</FtpUserName>
        <FtpPassword>string</FtpPassword>
        <FtpIPAddress>string</FtpIPAddress>
        <Version>string</Version>
        <DomainId>int</DomainId>
        <isManualConverstion>int</isManualConverstion>
      </StartFtpSessionResult>
    </StartFtpSessionResponse>
  </soap12:Body>
</soap12:Envelope>