VaultService Web Service

VaultService

Click here for a complete list of operations.

BeginLabelQueryWithFilter

Open a query on the server for labels

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: code.mises.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sourcegear.com/schemas/vault/BeginLabelQueryWithFilter"

<?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>
    <BeginLabelQueryWithFilter xmlns="http://www.sourcegear.com/schemas/vault">
      <vlqr>
        <RepID>int</RepID>
        <ItemPath>string</ItemPath>
        <ObjID>long</ObjID>
        <GetRecursive>boolean</GetRecursive>
        <ActRecursively>boolean</ActRecursively>
        <TxDateFilterType>int</TxDateFilterType>
        <TxBeginDate>
          <Ticks>long</Ticks>
        </TxBeginDate>
        <TxEndDate>
          <Ticks>long</Ticks>
        </TxEndDate>
        <LabelDateFilterType>int</LabelDateFilterType>
        <LabelBeginDate>
          <Ticks>long</Ticks>
        </LabelBeginDate>
        <LabelEndDate>
          <Ticks>long</Ticks>
        </LabelEndDate>
        <GetInherited>boolean</GetInherited>
        <ObjectType>unsignedShort</ObjectType>
        <LabelName>
          <string>string</string>
          <string>string</string>
        </LabelName>
        <NumChanges>int</NumChanges>
        <CommentFilter>int</CommentFilter>
        <nCommentString>string</nCommentString>
        <Users>
          <string>string</string>
          <string>string</string>
        </Users>
        <Sorts>
          <long>long</long>
          <long>long</long>
        </Sorts>
      </vlqr>
      <nRowLimit>long</nRowLimit>
    </BeginLabelQueryWithFilter>
  </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>
    <BeginLabelQueryWithFilterResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginLabelQueryWithFilterResult>int</BeginLabelQueryWithFilterResult>
      <nRowsRetrieved>long</nRowsRetrieved>
      <nRowsRetrievedRecursive>long</nRowsRetrievedRecursive>
      <strQryToken>string</strQryToken>
    </BeginLabelQueryWithFilterResponse>
  </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: code.mises.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>
    <BeginLabelQueryWithFilter xmlns="http://www.sourcegear.com/schemas/vault">
      <vlqr>
        <RepID>int</RepID>
        <ItemPath>string</ItemPath>
        <ObjID>long</ObjID>
        <GetRecursive>boolean</GetRecursive>
        <ActRecursively>boolean</ActRecursively>
        <TxDateFilterType>int</TxDateFilterType>
        <TxBeginDate>
          <Ticks>long</Ticks>
        </TxBeginDate>
        <TxEndDate>
          <Ticks>long</Ticks>
        </TxEndDate>
        <LabelDateFilterType>int</LabelDateFilterType>
        <LabelBeginDate>
          <Ticks>long</Ticks>
        </LabelBeginDate>
        <LabelEndDate>
          <Ticks>long</Ticks>
        </LabelEndDate>
        <GetInherited>boolean</GetInherited>
        <ObjectType>unsignedShort</ObjectType>
        <LabelName>
          <string>string</string>
          <string>string</string>
        </LabelName>
        <NumChanges>int</NumChanges>
        <CommentFilter>int</CommentFilter>
        <nCommentString>string</nCommentString>
        <Users>
          <string>string</string>
          <string>string</string>
        </Users>
        <Sorts>
          <long>long</long>
          <long>long</long>
        </Sorts>
      </vlqr>
      <nRowLimit>long</nRowLimit>
    </BeginLabelQueryWithFilter>
  </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>
    <BeginLabelQueryWithFilterResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginLabelQueryWithFilterResult>int</BeginLabelQueryWithFilterResult>
      <nRowsRetrieved>long</nRowsRetrieved>
      <nRowsRetrievedRecursive>long</nRowsRetrievedRecursive>
      <strQryToken>string</strQryToken>
    </BeginLabelQueryWithFilterResponse>
  </soap12:Body>
</soap12:Envelope>