You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Species List and Search Web Service API

URL

description

notes

data/species/list?locale=<locale to use for common name>

Return entire list of species names

 

data/species/find?q=<string to match>&locale=<locale used in match string and common name>

Return species that match query string

  • Can wildcards be used in the match string?
  • Matching happens against sci. names? Common names?

parameter

required

default

value options

description

 

 

 

 

 

locale

no

en_US

Java standard locale codes

locale in which to provide names in response and in which to match query string (when possible)

format

no

csv

  • csv
  • xml

format to use for response

CSV Result Format

<collection code>, <name associated with collection>
<collection code>, <name associated with collection>
<collection code>, <name associated with collection>
<collection code>, <name associated with collection>

XML Result Format
<response>
  <header>
    <locale country="US" language="en"/>
    <timestamp>2008-02-21T12:37:32.546-05:00</timestamp>
    <criteria>
      <property name="" value=""/>
    </criteria>
    <comment>
    </comment>
  </header>
  <result>
    <collection code="" >name of the collection </collection>
    <collection code="" >name of the collection </collection>
    <collection code="" >name of the collection </collection>
  </result>
</response
  • No labels