VaultService Web Service

VaultService

Click here for a complete list of operations.

GetUserOptionsEx

Get all options for the current user on the server. Pass NULL on param if Notification Options are not req'd

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

<?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>
    <GetUserOptionsEx xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <nCategoryID>int</nCategoryID>
      <nco>
        <UserID>int</UserID>
        <EmailNotificationEnabled>boolean</EmailNotificationEnabled>
        <EmailAddress>string</EmailAddress>
        <SendEmailAsDigest>boolean</SendEmailAsDigest>
        <SendEmailInHtml>boolean</SendEmailInHtml>
        <SuppressSelfGeneratedItems>boolean</SuppressSelfGeneratedItems>
        <ApplicationNotificationEnabled>boolean</ApplicationNotificationEnabled>
        <SCCRepID>int</SCCRepID>
        <SCCEvents>unsignedLong</SCCEvents>
        <SCCEndTxRequestTypes>
          <int>int</int>
          <int>int</int>
        </SCCEndTxRequestTypes>
        <SCCWatchedPathsAdded>
          <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>
        </SCCWatchedPathsAdded>
        <WITEvents>unsignedLong</WITEvents>
        <WITProjects>
          <WITProjectNotification>
            <ProjectID>int</ProjectID>
            <Project>string</Project>
            <Enabled>boolean</Enabled>
            <AssignmentCriteria>int</AssignmentCriteria>
            <ProjectNotificationChanged>boolean</ProjectNotificationChanged>
            <ProjectNotificationSubcsriptionChanged>boolean</ProjectNotificationSubcsriptionChanged>
            <SubscribedItems xsi:nil="true" />
          </WITProjectNotification>
          <WITProjectNotification>
            <ProjectID>int</ProjectID>
            <Project>string</Project>
            <Enabled>boolean</Enabled>
            <AssignmentCriteria>int</AssignmentCriteria>
            <ProjectNotificationChanged>boolean</ProjectNotificationChanged>
            <ProjectNotificationSubcsriptionChanged>boolean</ProjectNotificationSubcsriptionChanged>
            <SubscribedItems xsi:nil="true" />
          </WITProjectNotification>
        </WITProjects>
      </nco>
    </GetUserOptionsEx>
  </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>
    <GetUserOptionsExResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetUserOptionsExResult>int</GetUserOptionsExResult>
      <arNames>
        <string>string</string>
        <string>string</string>
      </arNames>
      <arValues>
        <string>string</string>
        <string>string</string>
      </arValues>
      <nco>
        <UserID>int</UserID>
        <EmailNotificationEnabled>boolean</EmailNotificationEnabled>
        <EmailAddress>string</EmailAddress>
        <SendEmailAsDigest>boolean</SendEmailAsDigest>
        <SendEmailInHtml>boolean</SendEmailInHtml>
        <SuppressSelfGeneratedItems>boolean</SuppressSelfGeneratedItems>
        <ApplicationNotificationEnabled>boolean</ApplicationNotificationEnabled>
        <SCCRepID>int</SCCRepID>
        <SCCEvents>unsignedLong</SCCEvents>
        <SCCEndTxRequestTypes>
          <int>int</int>
          <int>int</int>
        </SCCEndTxRequestTypes>
        <SCCWatchedPathsAdded>
          <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>
        </SCCWatchedPathsAdded>
        <WITEvents>unsignedLong</WITEvents>
        <WITProjects>
          <WITProjectNotification>
            <ProjectID>int</ProjectID>
            <Project>string</Project>
            <Enabled>boolean</Enabled>
            <AssignmentCriteria>int</AssignmentCriteria>
            <ProjectNotificationChanged>boolean</ProjectNotificationChanged>
            <ProjectNotificationSubcsriptionChanged>boolean</ProjectNotificationSubcsriptionChanged>
            <SubscribedItems xsi:nil="true" />
          </WITProjectNotification>
          <WITProjectNotification>
            <ProjectID>int</ProjectID>
            <Project>string</Project>
            <Enabled>boolean</Enabled>
            <AssignmentCriteria>int</AssignmentCriteria>
            <ProjectNotificationChanged>boolean</ProjectNotificationChanged>
            <ProjectNotificationSubcsriptionChanged>boolean</ProjectNotificationSubcsriptionChanged>
            <SubscribedItems xsi:nil="true" />
          </WITProjectNotification>
        </WITProjects>
      </nco>
    </GetUserOptionsExResponse>
  </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>
    <GetUserOptionsEx xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <nCategoryID>int</nCategoryID>
      <nco>
        <UserID>int</UserID>
        <EmailNotificationEnabled>boolean</EmailNotificationEnabled>
        <EmailAddress>string</EmailAddress>
        <SendEmailAsDigest>boolean</SendEmailAsDigest>
        <SendEmailInHtml>boolean</SendEmailInHtml>
        <SuppressSelfGeneratedItems>boolean</SuppressSelfGeneratedItems>
        <ApplicationNotificationEnabled>boolean</ApplicationNotificationEnabled>
        <SCCRepID>int</SCCRepID>
        <SCCEvents>unsignedLong</SCCEvents>
        <SCCEndTxRequestTypes>
          <int>int</int>
          <int>int</int>
        </SCCEndTxRequestTypes>
        <SCCWatchedPathsAdded>
          <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>
        </SCCWatchedPathsAdded>
        <WITEvents>unsignedLong</WITEvents>
        <WITProjects>
          <WITProjectNotification>
            <ProjectID>int</ProjectID>
            <Project>string</Project>
            <Enabled>boolean</Enabled>
            <AssignmentCriteria>int</AssignmentCriteria>
            <ProjectNotificationChanged>boolean</ProjectNotificationChanged>
            <ProjectNotificationSubcsriptionChanged>boolean</ProjectNotificationSubcsriptionChanged>
            <SubscribedItems xsi:nil="true" />
          </WITProjectNotification>
          <WITProjectNotification>
            <ProjectID>int</ProjectID>
            <Project>string</Project>
            <Enabled>boolean</Enabled>
            <AssignmentCriteria>int</AssignmentCriteria>
            <ProjectNotificationChanged>boolean</ProjectNotificationChanged>
            <ProjectNotificationSubcsriptionChanged>boolean</ProjectNotificationSubcsriptionChanged>
            <SubscribedItems xsi:nil="true" />
          </WITProjectNotification>
        </WITProjects>
      </nco>
    </GetUserOptionsEx>
  </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>
    <GetUserOptionsExResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetUserOptionsExResult>int</GetUserOptionsExResult>
      <arNames>
        <string>string</string>
        <string>string</string>
      </arNames>
      <arValues>
        <string>string</string>
        <string>string</string>
      </arValues>
      <nco>
        <UserID>int</UserID>
        <EmailNotificationEnabled>boolean</EmailNotificationEnabled>
        <EmailAddress>string</EmailAddress>
        <SendEmailAsDigest>boolean</SendEmailAsDigest>
        <SendEmailInHtml>boolean</SendEmailInHtml>
        <SuppressSelfGeneratedItems>boolean</SuppressSelfGeneratedItems>
        <ApplicationNotificationEnabled>boolean</ApplicationNotificationEnabled>
        <SCCRepID>int</SCCRepID>
        <SCCEvents>unsignedLong</SCCEvents>
        <SCCEndTxRequestTypes>
          <int>int</int>
          <int>int</int>
        </SCCEndTxRequestTypes>
        <SCCWatchedPathsAdded>
          <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>
        </SCCWatchedPathsAdded>
        <WITEvents>unsignedLong</WITEvents>
        <WITProjects>
          <WITProjectNotification>
            <ProjectID>int</ProjectID>
            <Project>string</Project>
            <Enabled>boolean</Enabled>
            <AssignmentCriteria>int</AssignmentCriteria>
            <ProjectNotificationChanged>boolean</ProjectNotificationChanged>
            <ProjectNotificationSubcsriptionChanged>boolean</ProjectNotificationSubcsriptionChanged>
            <SubscribedItems xsi:nil="true" />
          </WITProjectNotification>
          <WITProjectNotification>
            <ProjectID>int</ProjectID>
            <Project>string</Project>
            <Enabled>boolean</Enabled>
            <AssignmentCriteria>int</AssignmentCriteria>
            <ProjectNotificationChanged>boolean</ProjectNotificationChanged>
            <ProjectNotificationSubcsriptionChanged>boolean</ProjectNotificationSubcsriptionChanged>
            <SubscribedItems xsi:nil="true" />
          </WITProjectNotification>
        </WITProjects>
      </nco>
    </GetUserOptionsExResponse>
  </soap12:Body>
</soap12:Envelope>