Panel | |
---|---|
|
CountryCode List and Search Web Service API
API
URL | description | status | notes |
---|---|---|---|
ws/ref/country/list | Return entire list of country names and codes | coded, not deployed |
|
ws/ref/country/find?match=<string to match> | Return list of country names and their codes that match | coded, not deployed | What wildcards be used in the match string? No wildcard yet implemented. |
parameter | required | default | value options | description | status |
---|---|---|---|---|---|
match | yes, for /find | n/a |
| String to match against "country" names. What kind of wildcards can be used? | coded, not deployed. No wildcard yet implemented. |
locale | no | en_US | Java standard locale codes | locale in which to perform matching, and in which to provide names in response (when possible) | not coded |
format | no | csv |
| format to use for response | deployed not coded |
Test URLS
Development URL | Deployed URL | Expected Response | Notes | ||||
---|---|---|---|---|---|---|---|
entire list in CSV format | Generates 404 | ||||||
|
| What do we want here? 404? Redirect to /ws/ref/country/list? | http://localhost/wsebird.org/ws1.0/ref/[]country/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 countries in CSV format CSV list of 5 countries |
| |||||
http://localhost/ws/ref/[]country/find?match=united&format=xml | http://ebird.org/ws1.0/ref/country/find?match=united&format=xml | XML list of 5 countries |
| ||||
| list of countries in CSV format CSV list of 5 countries | 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 |
---|
<country code>, <name associated with country code> |
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="something"/> </criteria> <comment> </comment> </header> <result> <location countryCode="" >name of the country </location> <location countryCode="" >name of the country </location> <location countryCode="" >name of the country </location> </response> |