VaultService Web Service

VaultService

Click here for a complete list of operations.

GetNotificationCriteriaOptions

Get notification criteria for a given user's repository

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

<?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>
    <GetNotificationCriteriaOptions xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
    </GetNotificationCriteriaOptions>
  </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>
    <GetNotificationCriteriaOptionsResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetNotificationCriteriaOptionsResult>int</GetNotificationCriteriaOptionsResult>
      <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>
    </GetNotificationCriteriaOptionsResponse>
  </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>
    <GetNotificationCriteriaOptions xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
    </GetNotificationCriteriaOptions>
  </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>
    <GetNotificationCriteriaOptionsResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetNotificationCriteriaOptionsResult>int</GetNotificationCriteriaOptionsResult>
      <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>
    </GetNotificationCriteriaOptionsResponse>
  </soap12:Body>
</soap12:Envelope>