| Panel | |
|---|---|
|
Species List and Search Web Service API
API
This API provides a way to find out what species for which we hold data.
URL | description | status | notes |
|---|---|---|---|
ws/data/species/list ?locale=<locale to use for common name> | Return entire list of species names | deployed |
|
ws/data/species/find?qmatch=<string to match> &locale=<locale used in match string and common name> | Return species that match query string | deployed | No wildcard yet implemented Can wildcards be usedin the match string?Matching happens against sci. names? Common names?matching string. |
parameter | required | default | value options | description |
|
|
|
| |
|---|---|---|---|---|---|---|---|---|---|
dataService | -proposed- | -proposed- | -proposed- | -proposed- | |||||
collection | no | n/a | 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 |
| format to use for response |
Test URLS
Development URL | Deployed URL | Expected Response | Notes |
|---|---|---|---|
entire list in CSV format | Generates 404 error. | ||
entire list in CSV format | "csv" is the default format. | ||
entire list in XML format |
| ||
entire list in CSV format |
| ||
entire list in CSV format | Bad format value is ignored and defaulted to csv. | ||
entire list in CSV format | "XML" is not a valid format option. Only "xml" and "csv" are valid options. | ||
CSV list of species |
| ||
http://localhost/ws/data/species/find?match=streptopelia&format=xml | http://ebird.org/ws1.0/data/species/find?match=streptopelia&format=xml | XML list of species |
|
CSV list of species | There should be no difference in response for upper/lower case search strings. | ||
entire list in CSV format | Bad format value is ignored and defaulted to csv. | ||
empty list in CSV format |
|
CSV Result Format
| Panel |
|---|
<collection code>, <name associated with collection> |
XML Result Format
| No 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="dataService" value="dskfjsdklfj" />
<property name="collection" value="dsafsfsdkljfslkfj"/>
</criteria>
<comment>
</comment>
</header>
<result>
<species> <scientific-name>XXXXX</scientific-name> <collection code="" >name of the collection <common-name>YYYYY</common-name> </collection>
species>
<species> <scientific-name>XXXXX</scientific-name> <collection code="" >name of the collection <common-name>YYYYY</common-name> </collection>species>
<collection code="" >name of the collection </collection><species> <scientific-name>XXXXX</scientific-name> <common-name>YYYYY</common-name> </species>
</result>
</response
|