VaultService Web Service

VaultService

Click here for a complete list of operations.

GetHistoryFavorites

Add a history favorite for the current user on the server.

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

<?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>
    <GetHistoryFavorites xmlns="http://www.sourcegear.com/schemas/vault">
      <vhFavs>
        <VaultHistoryFavorite>
          <Name>string</Name>
          <ID>int</ID>
          <QueryRequest>
            <IsFolder>boolean</IsFolder>
            <RepID>int</RepID>
            <TopID>long</TopID>
            <TopName>string</TopName>
            <Recursive>boolean</Recursive>
            <DateFilterType>int</DateFilterType>
            <LabelFilterType>int</LabelFilterType>
            <DateFilterMask>unsignedInt</DateFilterMask>
            <IncludePastDays>int</IncludePastDays>
            <BeginDate xsi:nil="true" />
            <LabelBeginDate xsi:nil="true" />
            <EndDate xsi:nil="true" />
            <LabelEndDate xsi:nil="true" />
            <LabelBeginName>string</LabelBeginName>
            <LabelEndName>string</LabelEndName>
            <SubstringType>int</SubstringType>
            <Substrings xsi:nil="true" />
            <Users xsi:nil="true" />
            <Actions xsi:nil="true" />
            <CommentFilter>int</CommentFilter>
            <CommentSubstring>string</CommentSubstring>
            <Sorts xsi:nil="true" />
          </QueryRequest>
          <QueryType>unsignedByte</QueryType>
          <IncludeVersionLabels>boolean</IncludeVersionLabels>
        </VaultHistoryFavorite>
        <VaultHistoryFavorite>
          <Name>string</Name>
          <ID>int</ID>
          <QueryRequest>
            <IsFolder>boolean</IsFolder>
            <RepID>int</RepID>
            <TopID>long</TopID>
            <TopName>string</TopName>
            <Recursive>boolean</Recursive>
            <DateFilterType>int</DateFilterType>
            <LabelFilterType>int</LabelFilterType>
            <DateFilterMask>unsignedInt</DateFilterMask>
            <IncludePastDays>int</IncludePastDays>
            <BeginDate xsi:nil="true" />
            <LabelBeginDate xsi:nil="true" />
            <EndDate xsi:nil="true" />
            <LabelEndDate xsi:nil="true" />
            <LabelBeginName>string</LabelBeginName>
            <LabelEndName>string</LabelEndName>
            <SubstringType>int</SubstringType>
            <Substrings xsi:nil="true" />
            <Users xsi:nil="true" />
            <Actions xsi:nil="true" />
            <CommentFilter>int</CommentFilter>
            <CommentSubstring>string</CommentSubstring>
            <Sorts xsi:nil="true" />
          </QueryRequest>
          <QueryType>unsignedByte</QueryType>
          <IncludeVersionLabels>boolean</IncludeVersionLabels>
        </VaultHistoryFavorite>
      </vhFavs>
      <bSendDetails>boolean</bSendDetails>
    </GetHistoryFavorites>
  </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>
    <GetHistoryFavoritesResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetHistoryFavoritesResult>int</GetHistoryFavoritesResult>
      <vhFavs>
        <VaultHistoryFavorite>
          <Name>string</Name>
          <ID>int</ID>
          <QueryRequest>
            <IsFolder>boolean</IsFolder>
            <RepID>int</RepID>
            <TopID>long</TopID>
            <TopName>string</TopName>
            <Recursive>boolean</Recursive>
            <DateFilterType>int</DateFilterType>
            <LabelFilterType>int</LabelFilterType>
            <DateFilterMask>unsignedInt</DateFilterMask>
            <IncludePastDays>int</IncludePastDays>
            <BeginDate xsi:nil="true" />
            <LabelBeginDate xsi:nil="true" />
            <EndDate xsi:nil="true" />
            <LabelEndDate xsi:nil="true" />
            <LabelBeginName>string</LabelBeginName>
            <LabelEndName>string</LabelEndName>
            <SubstringType>int</SubstringType>
            <Substrings xsi:nil="true" />
            <Users xsi:nil="true" />
            <Actions xsi:nil="true" />
            <CommentFilter>int</CommentFilter>
            <CommentSubstring>string</CommentSubstring>
            <Sorts xsi:nil="true" />
          </QueryRequest>
          <QueryType>unsignedByte</QueryType>
          <IncludeVersionLabels>boolean</IncludeVersionLabels>
        </VaultHistoryFavorite>
        <VaultHistoryFavorite>
          <Name>string</Name>
          <ID>int</ID>
          <QueryRequest>
            <IsFolder>boolean</IsFolder>
            <RepID>int</RepID>
            <TopID>long</TopID>
            <TopName>string</TopName>
            <Recursive>boolean</Recursive>
            <DateFilterType>int</DateFilterType>
            <LabelFilterType>int</LabelFilterType>
            <DateFilterMask>unsignedInt</DateFilterMask>
            <IncludePastDays>int</IncludePastDays>
            <BeginDate xsi:nil="true" />
            <LabelBeginDate xsi:nil="true" />
            <EndDate xsi:nil="true" />
            <LabelEndDate xsi:nil="true" />
            <LabelBeginName>string</LabelBeginName>
            <LabelEndName>string</LabelEndName>
            <SubstringType>int</SubstringType>
            <Substrings xsi:nil="true" />
            <Users xsi:nil="true" />
            <Actions xsi:nil="true" />
            <CommentFilter>int</CommentFilter>
            <CommentSubstring>string</CommentSubstring>
            <Sorts xsi:nil="true" />
          </QueryRequest>
          <QueryType>unsignedByte</QueryType>
          <IncludeVersionLabels>boolean</IncludeVersionLabels>
        </VaultHistoryFavorite>
      </vhFavs>
    </GetHistoryFavoritesResponse>
  </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>
    <GetHistoryFavorites xmlns="http://www.sourcegear.com/schemas/vault">
      <vhFavs>
        <VaultHistoryFavorite>
          <Name>string</Name>
          <ID>int</ID>
          <QueryRequest>
            <IsFolder>boolean</IsFolder>
            <RepID>int</RepID>
            <TopID>long</TopID>
            <TopName>string</TopName>
            <Recursive>boolean</Recursive>
            <DateFilterType>int</DateFilterType>
            <LabelFilterType>int</LabelFilterType>
            <DateFilterMask>unsignedInt</DateFilterMask>
            <IncludePastDays>int</IncludePastDays>
            <BeginDate xsi:nil="true" />
            <LabelBeginDate xsi:nil="true" />
            <EndDate xsi:nil="true" />
            <LabelEndDate xsi:nil="true" />
            <LabelBeginName>string</LabelBeginName>
            <LabelEndName>string</LabelEndName>
            <SubstringType>int</SubstringType>
            <Substrings xsi:nil="true" />
            <Users xsi:nil="true" />
            <Actions xsi:nil="true" />
            <CommentFilter>int</CommentFilter>
            <CommentSubstring>string</CommentSubstring>
            <Sorts xsi:nil="true" />
          </QueryRequest>
          <QueryType>unsignedByte</QueryType>
          <IncludeVersionLabels>boolean</IncludeVersionLabels>
        </VaultHistoryFavorite>
        <VaultHistoryFavorite>
          <Name>string</Name>
          <ID>int</ID>
          <QueryRequest>
            <IsFolder>boolean</IsFolder>
            <RepID>int</RepID>
            <TopID>long</TopID>
            <TopName>string</TopName>
            <Recursive>boolean</Recursive>
            <DateFilterType>int</DateFilterType>
            <LabelFilterType>int</LabelFilterType>
            <DateFilterMask>unsignedInt</DateFilterMask>
            <IncludePastDays>int</IncludePastDays>
            <BeginDate xsi:nil="true" />
            <LabelBeginDate xsi:nil="true" />
            <EndDate xsi:nil="true" />
            <LabelEndDate xsi:nil="true" />
            <LabelBeginName>string</LabelBeginName>
            <LabelEndName>string</LabelEndName>
            <SubstringType>int</SubstringType>
            <Substrings xsi:nil="true" />
            <Users xsi:nil="true" />
            <Actions xsi:nil="true" />
            <CommentFilter>int</CommentFilter>
            <CommentSubstring>string</CommentSubstring>
            <Sorts xsi:nil="true" />
          </QueryRequest>
          <QueryType>unsignedByte</QueryType>
          <IncludeVersionLabels>boolean</IncludeVersionLabels>
        </VaultHistoryFavorite>
      </vhFavs>
      <bSendDetails>boolean</bSendDetails>
    </GetHistoryFavorites>
  </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>
    <GetHistoryFavoritesResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetHistoryFavoritesResult>int</GetHistoryFavoritesResult>
      <vhFavs>
        <VaultHistoryFavorite>
          <Name>string</Name>
          <ID>int</ID>
          <QueryRequest>
            <IsFolder>boolean</IsFolder>
            <RepID>int</RepID>
            <TopID>long</TopID>
            <TopName>string</TopName>
            <Recursive>boolean</Recursive>
            <DateFilterType>int</DateFilterType>
            <LabelFilterType>int</LabelFilterType>
            <DateFilterMask>unsignedInt</DateFilterMask>
            <IncludePastDays>int</IncludePastDays>
            <BeginDate xsi:nil="true" />
            <LabelBeginDate xsi:nil="true" />
            <EndDate xsi:nil="true" />
            <LabelEndDate xsi:nil="true" />
            <LabelBeginName>string</LabelBeginName>
            <LabelEndName>string</LabelEndName>
            <SubstringType>int</SubstringType>
            <Substrings xsi:nil="true" />
            <Users xsi:nil="true" />
            <Actions xsi:nil="true" />
            <CommentFilter>int</CommentFilter>
            <CommentSubstring>string</CommentSubstring>
            <Sorts xsi:nil="true" />
          </QueryRequest>
          <QueryType>unsignedByte</QueryType>
          <IncludeVersionLabels>boolean</IncludeVersionLabels>
        </VaultHistoryFavorite>
        <VaultHistoryFavorite>
          <Name>string</Name>
          <ID>int</ID>
          <QueryRequest>
            <IsFolder>boolean</IsFolder>
            <RepID>int</RepID>
            <TopID>long</TopID>
            <TopName>string</TopName>
            <Recursive>boolean</Recursive>
            <DateFilterType>int</DateFilterType>
            <LabelFilterType>int</LabelFilterType>
            <DateFilterMask>unsignedInt</DateFilterMask>
            <IncludePastDays>int</IncludePastDays>
            <BeginDate xsi:nil="true" />
            <LabelBeginDate xsi:nil="true" />
            <EndDate xsi:nil="true" />
            <LabelEndDate xsi:nil="true" />
            <LabelBeginName>string</LabelBeginName>
            <LabelEndName>string</LabelEndName>
            <SubstringType>int</SubstringType>
            <Substrings xsi:nil="true" />
            <Users xsi:nil="true" />
            <Actions xsi:nil="true" />
            <CommentFilter>int</CommentFilter>
            <CommentSubstring>string</CommentSubstring>
            <Sorts xsi:nil="true" />
          </QueryRequest>
          <QueryType>unsignedByte</QueryType>
          <IncludeVersionLabels>boolean</IncludeVersionLabels>
        </VaultHistoryFavorite>
      </vhFavs>
    </GetHistoryFavoritesResponse>
  </soap12:Body>
</soap12:Envelope>