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

Compare with Current View Page History

« Previous Version 4 Next »

Species List and Search Web Service API

This API provides a way to find out what species for which we hold data.

URL

description

notes

data/species/list

Return entire list of species names

 

data/species/find?match=<string to match>

Return species that match query string

 

parameter

required

default

value options

description

collection

no

n/a

AKN collection codes, eBird collection codes

limits search for the species name to a certain collection

match

yes, for /find

n/a

 

string to use in matching against sci. name (and common name?); are wildcard allowed in the match string?

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

Outstanding Questions and Issues
  • Does this search against or list from species found in data? Or, species from taxonomies in use?
CSV Result Format

<sci. name>, <common name>
<sci. name>, <common name>
<sci. name>, <common name>

XML Result Format
<response>
  <header>
    <locale country="US" language="en"/>
    <timestamp>2008-02-21T12:37:32.546-05:00</timestamp>
    <criteria>
      <property name="match" value="kldsfsd"/>
      <property name="collection" value="dsafsfsdkljfslkfj"/>
    </criteria>
    <comment>
    </comment>
  </header>
  <result>
     <species>      <scientific-name>XXXXX</scientific-name>      <common-name>YYYYY</common-name>    </species>
     <species>      <scientific-name>XXXXX</scientific-name>      <common-name>YYYYY</common-name>    </species>
     <species>      <scientific-name>XXXXX</scientific-name>      <common-name>YYYYY</common-name>    </species>

  </result>
</response
  • No labels