VaultService Web Service

VaultService

Click here for a complete list of operations.

SetUserOptionsAndNotificationCriteria

Set options and notification criteria for the current user.

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

<?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>
    <SetUserOptionsAndNotificationCriteria xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <nCategoryID>int</nCategoryID>
      <names>
        <string>string</string>
        <string>string</string>
      </names>
      <values>
        <string>string</string>
        <string>string</string>
      </values>
      <unco>
        <GeneralCriteriaUpdated>boolean</GeneralCriteriaUpdated>
        <EmailCriteriaUpdated>boolean</EmailCriteriaUpdated>
        <ApplicationCriteriaUpdated>boolean</ApplicationCriteriaUpdated>
        <SCCCriteriaUpdated>boolean</SCCCriteriaUpdated>
        <SCCWatchedPathsUpdated>boolean</SCCWatchedPathsUpdated>
        <SCCWatchedPathsDeleted>
          <VaultWatcher>
            <FullPath>string</FullPath>
            <ID>long</ID>
            <UserID>int</UserID>
            <WatcherType>AllChanges or NextLockReleaseOnly</WatcherType>
          </VaultWatcher>
          <VaultWatcher>
            <FullPath>string</FullPath>
            <ID>long</ID>
            <UserID>int</UserID>
            <WatcherType>AllChanges or NextLockReleaseOnly</WatcherType>
          </VaultWatcher>
        </SCCWatchedPathsDeleted>
        <WITEventCriteriaUpdated>boolean</WITEventCriteriaUpdated>
        <WITProjectsSubscribedItemsUpdated>boolean</WITProjectsSubscribedItemsUpdated>
      </unco>
    </SetUserOptionsAndNotificationCriteria>
  </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>
    <SetUserOptionsAndNotificationCriteriaResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <SetUserOptionsAndNotificationCriteriaResult>int</SetUserOptionsAndNotificationCriteriaResult>
    </SetUserOptionsAndNotificationCriteriaResponse>
  </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>
    <SetUserOptionsAndNotificationCriteria xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <nCategoryID>int</nCategoryID>
      <names>
        <string>string</string>
        <string>string</string>
      </names>
      <values>
        <string>string</string>
        <string>string</string>
      </values>
      <unco>
        <GeneralCriteriaUpdated>boolean</GeneralCriteriaUpdated>
        <EmailCriteriaUpdated>boolean</EmailCriteriaUpdated>
        <ApplicationCriteriaUpdated>boolean</ApplicationCriteriaUpdated>
        <SCCCriteriaUpdated>boolean</SCCCriteriaUpdated>
        <SCCWatchedPathsUpdated>boolean</SCCWatchedPathsUpdated>
        <SCCWatchedPathsDeleted>
          <VaultWatcher>
            <FullPath>string</FullPath>
            <ID>long</ID>
            <UserID>int</UserID>
            <WatcherType>AllChanges or NextLockReleaseOnly</WatcherType>
          </VaultWatcher>
          <VaultWatcher>
            <FullPath>string</FullPath>
            <ID>long</ID>
            <UserID>int</UserID>
            <WatcherType>AllChanges or NextLockReleaseOnly</WatcherType>
          </VaultWatcher>
        </SCCWatchedPathsDeleted>
        <WITEventCriteriaUpdated>boolean</WITEventCriteriaUpdated>
        <WITProjectsSubscribedItemsUpdated>boolean</WITProjectsSubscribedItemsUpdated>
      </unco>
    </SetUserOptionsAndNotificationCriteria>
  </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>
    <SetUserOptionsAndNotificationCriteriaResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <SetUserOptionsAndNotificationCriteriaResult>int</SetUserOptionsAndNotificationCriteriaResult>
    </SetUserOptionsAndNotificationCriteriaResponse>
  </soap12:Body>
</soap12:Envelope>