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 |
Return entire list of species names |
coded, not deployed |
|
ws/data/species/find?match=<string to match> |
Return species that match query string |
coded, not deployed |
No wildcard yet implemented in the 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 |
What do we want here? 404? Redirect to /ws/data/species/list? |
|
|
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. |
|
|
list of species |
|
|
http://localhost/ws/data/species/find?match=streptopelia&format=xml |
|
XML list of species |
|
|
list of 5 species in CSV format |
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
<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="dataService" value="dskfjsdklfj" /> <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