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

getThesaurus

Retrieve list of terms and their relationships from a BCH Thesaurus domain.

[Visual Basic]

Public Function getThesaurus(domainID As Integer) As String

[C#]

public string getThesaurus(int domainID);

Parameters

domainID
    The ID of the BCH Thesaurus domain.

Return Value

A string containing the requested domain terms in XML. If the method fails, SOAP exception will be thrown.

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

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

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

         <domainID>int</domainID>
    

      </getThesaurus>
  

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

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

         <getThesaurusResult>string</getThesaurusResult>
    

      </getThesaurusResponse>
  

   </soap:Body>

</soap:Envelope>

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