VaultService Web Service

VaultService

Click here for a complete list of operations.

GetLabelStructure

Get a delta describing the label found at item path.

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/GetLabelStructure"

<?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>
    <GetLabelStructure xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <strItemPath>string</strItemPath>
      <nLabelID>long</nLabelID>
      <strLabel>string</strLabel>
      <strLabelSubPath>string</strLabelSubPath>
    </GetLabelStructure>
  </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>
    <GetLabelStructureResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetLabelStructureResult>int</GetLabelStructureResult>
      <nLabelID>long</nLabelID>
      <strLabel>string</strLabel>
      <arLabelPaths>
        <string>string</string>
        <string>string</string>
      </arLabelPaths>
      <arObjLabelPaths>
        <string>string</string>
        <string>string</string>
      </arObjLabelPaths>
      <nRootID>long</nRootID>
      <dtLastModified>
        <Ticks>long</Ticks>
      </dtLastModified>
      <rd>
        <BaseRevision>long</BaseRevision>
        <TargetRevision>long</TargetRevision>
        <BaseName>string</BaseName>
        <TargetName>string</TargetName>
        <Root>
          <Folders>
            <VaultFolderDelta xsi:nil="true" />
            <VaultFolderDelta xsi:nil="true" />
          </Folders>
          <Files>
            <VaultFileDelta xsi:nil="true" />
            <VaultFileDelta xsi:nil="true" />
          </Files>
        </Root>
        <Shares>
          <long>long</long>
          <long>long</long>
        </Shares>
      </rd>
      <fd>
        <Mergeable>int</Mergeable>
        <EOL>int</EOL>
        <FileLength>long</FileLength>
        <FileCRC>unsignedInt</FileCRC>
      </fd>
    </GetLabelStructureResponse>
  </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>
    <GetLabelStructure xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <strItemPath>string</strItemPath>
      <nLabelID>long</nLabelID>
      <strLabel>string</strLabel>
      <strLabelSubPath>string</strLabelSubPath>
    </GetLabelStructure>
  </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>
    <GetLabelStructureResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetLabelStructureResult>int</GetLabelStructureResult>
      <nLabelID>long</nLabelID>
      <strLabel>string</strLabel>
      <arLabelPaths>
        <string>string</string>
        <string>string</string>
      </arLabelPaths>
      <arObjLabelPaths>
        <string>string</string>
        <string>string</string>
      </arObjLabelPaths>
      <nRootID>long</nRootID>
      <dtLastModified>
        <Ticks>long</Ticks>
      </dtLastModified>
      <rd>
        <BaseRevision>long</BaseRevision>
        <TargetRevision>long</TargetRevision>
        <BaseName>string</BaseName>
        <TargetName>string</TargetName>
        <Root>
          <Folders>
            <VaultFolderDelta xsi:nil="true" />
            <VaultFolderDelta xsi:nil="true" />
          </Folders>
          <Files>
            <VaultFileDelta xsi:nil="true" />
            <VaultFileDelta xsi:nil="true" />
          </Files>
        </Root>
        <Shares>
          <long>long</long>
          <long>long</long>
        </Shares>
      </rd>
      <fd>
        <Mergeable>int</Mergeable>
        <EOL>int</EOL>
        <FileLength>long</FileLength>
        <FileCRC>unsignedInt</FileCRC>
      </fd>
    </GetLabelStructureResponse>
  </soap12:Body>
</soap12:Envelope>