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?match=<string to match>&locale=<locale used in match string and common name> |
Return species that match query string |
|
parameter |
required |
default |
value options |
description |
---|---|---|---|---|
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 |
|
format to use for response |
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"/> </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