Back | Webservices | Home

Authenticate

Description

Used to check you are authenticated. You will need to include the soap:header in all calls to the webservice

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password
This operation does not have any request parameters.

Response Elements

Name Description

AuthenticateResult

AuthenticateResult element.

Type: Boolean

Example using SOAP

Example Request

The following is a sample SOAP 1.2 request and response.

<?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>
    <UserCredentials xmlns="http://vidzapper.net/Webservice/">
      <Userid>string</Userid>
      <Password>string</Password>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <Authenticate xmlns="http://vidzapper.net/Webservice/" />
  </soap12:Body>
</soap12:Envelope>

Example Response

<?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://vidzapper.net/Webservice/">
      <AuthenticateResult>boolean</AuthenticateResult>
    </AuthenticateResponse>
  </soap12:Body>
</soap12:Envelope>