GSRAuthenticate

Use this method to authenticate a username and passwords for an account to access the AppMon Performance Network.

Request parameters

You can use either a SOAP or HTTP call for this method. To call this web service from the browser, submit the following Get Request:

http://gpn.webservice.gomez.com/AccountManagementWS_20/AccountManagementWS.asmx/GSRAuthenticate?sUsername=string&sPassword=string

After specifying the following parameters:

  • sUsername – The account username
  • sPassword – The account password

Validation criteria

  • sUsername is valid for an account.
  • sPassword is valid for the specified username.

For more information, see Retrieving Specific Account Management Data.

Response XML

STATUS_FAILED

If the web service operation fails, the STATUS_FAILED status and an error message are returned in the following XML format:

<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>
  <GSRAuthenticateResponse
      xmlns="http://gomeznetworks.com/webservices/">
      <GSRAuthenticateResult>
        <Status>
           <eStatus>STATUS_FAILED</eStatus>
 <CAccountAuthenticationDataExport>
   <Status>
    <eStatus>STATUS_FAILED</eStatus>
     <sErrorMessage>INVALID ACCOUNT<sErrorMessage/>
   </Status>
   </GSRAuthenticate>
  </soap:Body>
</soap:Envelope>

SUCCESS

If the web service operation succeeds, the following requested information is returned in the following XML format:

<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>
  <GSRAuthenticateResponse
      xmlns="http://gomeznetworks.com/webservices/">
      <GSRAuthenticateResult>
        <Status>
           <eStatus>STATUS_SUCCESS</eStatus>
           <sErrorMessage />
        </Status>
      <AccountConstraints MaxScriptPages="10" />
   </GSRAuthenticate>
  </soap:Body>
</soap:Envelope>

Output

The following table summarizes the main elements, attributes, and possible attribute values in the XML response returned by this web service. Retrieve the WDSL for the complete definition of this XML response. For more information, see Retrieving Account Management Data.

Attribute Description Parent Element Child Elements
<GSRAuthenticateResponse> Top-level container for the XML response of this web service None <Status> <AccountConstraints>
<Status> The container for the information about the status of the operation <GSRAuthenticateResponse> <eStatus> <sErrorMessage>
<eStatus> STATUS_SUCCESS STATUS_FAILED STATUS_DATA_NOT_READY <Status> None
<sErrorMessage> A detailed error message if the status is STATUS_FAILED <Status> None
<AccountConstraints> The container for the account summary information <GSRAuthenticateResponse> None
MaxScriptPages The maximum number of pages accessible to the script recorder

Other SOAP and HTTP examples

http://gpn.webservice.gomez.com/AccountManagementWS_20/AccountManagementWS.asmx?op=GSRAuthenticate