VaultNotifyService Web Service

VaultNotifyService

Click here for a complete list of operations.

Authenticate

Authentication to notification service - uses Vault server session information to ensure this service is working with an authenticated 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 /VaultNotifyService/VaultNotifyService.asmx HTTP/1.1
Host: vaultdemo.sourcegear.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sourcegear.com/schemas/vaultplugin/Authenticate"

<?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>
    <Authenticate xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
      <guidSecurityToken>guid</guidSecurityToken>
      <strClientUserHostAddress>string</strClientUserHostAddress>
      <nUserID>int</nUserID>
      <strVaultServiceSessionID>string</strVaultServiceSessionID>
    </Authenticate>
  </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>
    <AuthenticateResponse xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
      <AuthenticateResult>int</AuthenticateResult>
      <strAuthTicket>string</strAuthTicket>
      <nAppNotifyEnabled>int</nAppNotifyEnabled>
    </AuthenticateResponse>
  </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 /VaultNotifyService/VaultNotifyService.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:Body>
    <Authenticate xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
      <guidSecurityToken>guid</guidSecurityToken>
      <strClientUserHostAddress>string</strClientUserHostAddress>
      <nUserID>int</nUserID>
      <strVaultServiceSessionID>string</strVaultServiceSessionID>
    </Authenticate>
  </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>
    <AuthenticateResponse xmlns="http://www.sourcegear.com/schemas/vaultplugin/">
      <AuthenticateResult>int</AuthenticateResult>
      <strAuthTicket>string</strAuthTicket>
      <nAppNotifyEnabled>int</nAppNotifyEnabled>
    </AuthenticateResponse>
  </soap12:Body>
</soap12:Envelope>