| | english | español | français |
  Home|Resources|BCH Interoperability Services 3.0|checkAccount   Printer-friendly version

checkAccount

Check the validity of the BCH user account and password.

[Visual Basic]

Public Sub checkAccount(email As String, password As String)

[C#]

public void checkAccount(string email, string password);

Parameters

email
    The registered email address

password
    The password

Return Value

The checkAccount method does not return any value. However, if the method fails, SOAP exception will be thrown.

Remarks

The BCH Web Service shares its user database with the Central Portal of the BCH. Therefore, any email address and password which are valid on the Central Portal of the BCH is valid.

The password being sent in plaintext across the network, the use of SSL is critical.

In the case where a digital certificate has been associated with the user account, the BCH Web Service will require the SOAP request to be digitaly signed using that digital certificate.

SOAP Request

The following is a sample SOAP request. The placeholders shown need to be replaced with actual values.

POST /service/3.0/service.asmx HTTP/1.1
Host: bch.biodiv.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://bch.biodiv.org/service/3.0/checkAccount"

<?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>
    

      <checkAccount xmlns="http://bch.biodiv.org/service/3.0">
      

         <email>string</email>
      

         <password>string</password>
    

      </checkAccount>
  

   </soap:Body>

</soap:Envelope>

SOAP Response

The following is a sample SOAP response. The placeholders shown need to be replaced with actual values.

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>
    

      <checkAccountResponse xmlns="http://bch.biodiv.org/service/3.0" />
  

   </soap:Body>

</soap:Envelope>

   
   
Update on 2008-01-18
United Nations Environment Programme United Nations