VaultService


Click here for a complete list of operations.

BeginDownloadLabelFiles

Begin a data download for a file found in a label.

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 /vaultservice/vaultservice.asmx HTTP/1.1
Host: vaultdemo.sourcegear.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sourcegear.com/schemas/vault/BeginDownloadLabelFiles"

<?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:Header>
    <VaultAuth xmlns="http://www.sourcegear.com/schemas/vault">
      <VaultSessionID>string</VaultSessionID>
      <Token>string</Token>
    </VaultAuth>
  </soap:Header>
  <soap:Body>
    <BeginDownloadLabelFiles xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <strPathToLabelItem>string</strPathToLabelItem>
      <nLabelID>long</nLabelID>
      <requests>
        <VaultRequestGetFile>
          <BaseObjVerID>long</BaseObjVerID>
          <TargetObjVerID>long</TargetObjVerID>
          <ObjID>long</ObjID>
          <Version>long</Version>
        </VaultRequestGetFile>
        <VaultRequestGetFile>
          <BaseObjVerID>long</BaseObjVerID>
          <TargetObjVerID>long</TargetObjVerID>
          <ObjID>long</ObjID>
          <Version>long</Version>
        </VaultRequestGetFile>
      </requests>
      <strDownloadID>string</strDownloadID>
    </BeginDownloadLabelFiles>
  </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>
    <BeginDownloadLabelFilesResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginDownloadLabelFilesResult>int</BeginDownloadLabelFilesResult>
      <requests>
        <VaultRequestGetFile>
          <BaseObjVerID>long</BaseObjVerID>
          <TargetObjVerID>long</TargetObjVerID>
          <ObjID>long</ObjID>
          <Version>long</Version>
        </VaultRequestGetFile>
        <VaultRequestGetFile>
          <BaseObjVerID>long</BaseObjVerID>
          <TargetObjVerID>long</TargetObjVerID>
          <ObjID>long</ObjID>
          <Version>long</Version>
        </VaultRequestGetFile>
      </requests>
      <strDownloadID>string</strDownloadID>
    </BeginDownloadLabelFilesResponse>
  </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 /vaultservice/vaultservice.asmx HTTP/1.1
Host: vaultdemo.sourcegear.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:Header>
    <VaultAuth xmlns="http://www.sourcegear.com/schemas/vault">
      <VaultSessionID>string</VaultSessionID>
      <Token>string</Token>
    </VaultAuth>
  </soap12:Header>
  <soap12:Body>
    <BeginDownloadLabelFiles xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <strPathToLabelItem>string</strPathToLabelItem>
      <nLabelID>long</nLabelID>
      <requests>
        <VaultRequestGetFile>
          <BaseObjVerID>long</BaseObjVerID>
          <TargetObjVerID>long</TargetObjVerID>
          <ObjID>long</ObjID>
          <Version>long</Version>
        </VaultRequestGetFile>
        <VaultRequestGetFile>
          <BaseObjVerID>long</BaseObjVerID>
          <TargetObjVerID>long</TargetObjVerID>
          <ObjID>long</ObjID>
          <Version>long</Version>
        </VaultRequestGetFile>
      </requests>
      <strDownloadID>string</strDownloadID>
    </BeginDownloadLabelFiles>
  </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>
    <BeginDownloadLabelFilesResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginDownloadLabelFilesResult>int</BeginDownloadLabelFilesResult>
      <requests>
        <VaultRequestGetFile>
          <BaseObjVerID>long</BaseObjVerID>
          <TargetObjVerID>long</TargetObjVerID>
          <ObjID>long</ObjID>
          <Version>long</Version>
        </VaultRequestGetFile>
        <VaultRequestGetFile>
          <BaseObjVerID>long</BaseObjVerID>
          <TargetObjVerID>long</TargetObjVerID>
          <ObjID>long</ObjID>
          <Version>long</Version>
        </VaultRequestGetFile>
      </requests>
      <strDownloadID>string</strDownloadID>
    </BeginDownloadLabelFilesResponse>
  </soap12:Body>
</soap12:Envelope>