query

Query syntax
Sample Xml queries

Retrieve a list of registered document(s) from the BCH matching search criterias.

[Visual Basic]

Public Function query(query As String) As String

[C#]

public string query(string query);

Parameters

query
The Query in xml format specifying criterias to find documents. Query syntax

Return value

A string containing the matching documents in simple XML format. 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/query"

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

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

         <query>string</query>

      </query>

   </soap:Body>

</soap:Envelope>

SOAP Response

The following is a sample SOAP response. 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/query"

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

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

         <queryResult>string</queryResult>

      </queryResponse>

   </soap:Body>

</soap:Envelope>

Relevant Links

To test the query method using the HTTP POST protocol.

Update on 2007-04-18

Rate this page