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

register

Register a new document or update an existing document on the BCH.

[Visual Basic]

Public Function register(document As String, email As String, password As String) As String

[C#]

public string register(string document, string email, string password);

Parameters

document
    A valid XML document

email
    The registered email address

password
    The password

Return Value

A confirmation token confirming the transaction. The maximum token length is 40 characters. If the method fails, a SOAP exception will be thrown.

Remarks

Email address and Password

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.

XML document

The XML document must conform to one of the BCH schemas (common formats). The document may optionally be digitally signed.

Document ID

The IDs of the registered documents are chosen by the organization which register them. By choosing themselves the ID of their document, the organization do not have to keep track of the BCH IDs.

The IDs must be universally unique. We encourage organization to include their domain name in the IDs. (e.g. http://www.gov.zz/decision/4323 or http://www.gov.zz/870F72A0-BD9F-4d71-9983-34FAEAD29399)

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

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

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

         <document>string</document>
      

         <email>string</email>
      

         <password>string</password>
    

      </register>
  

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

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

         <registerResult>string</registerResult>
    

      </registerResponse>
  

   </soap:Body>

</soap:Envelope>

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