Panel | |
---|---|
|
Subnational2Code List and Search Web Service API
API
This functionality is contained in the IS/DataDeliveryREST code base.
URL | description | status | notes |
---|---|---|---|
data ws/metaref/subnational2/list?countryCode=<2-letter ISO country code> | Return list of "county" names found in the given country | coded, not deployed |
|
data ws/metaref/subnational2/find?match=<string to match> | Return list of "county" names that match | deployed not coded | Can wildcards be used in the match string? No wildcard yet implemented. |
data ws/metaref/subnational2/list?subnational1Code=<eBird subnational1 <subnational1 code> | Return list of "county" names found in the given "state" | coded, not deployed |
|
parameter | required | default | value options | description | status | |
---|---|---|---|---|---|---|
match | yes, for /find | n/a |
| String to match against "county" names. What kind of wildcards can be used? | not coded 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 | |
countryCode | one of countryCode and subnational1Code is required for /list | n/a | 2-letter ISO country code | see CountryCode List and Search Web Service API | coded, not deployed | |
subnational1Code | one of countryCode and subnational1Code is required for /list | n/a | eBird standard subnational1Code | coded, not deployed | ||
format | no | csv |
| format to use for response | deployed |
Test URLS
CSV Result Format
Panel |
---|
<country code>, <subnational1 code>, <subnational2 code>, <name associated with subnational2 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="seomthing"/> <property name="subnational1Code" value="seomthing"/> <property name="countryCode" value="seomthing"/> </criteria> <comment> </comment> </header> <result> <location countryCode="" subnational1Code="" subnational2Code="">name of the subnational2 region </location> <location countryCode="" subnational1Code="" subnational2Code="">name of the subnational2 region </location> <location countryCode="" subnational1Code="" subnational2Code="">name of the subnational2 region </location> <location countryCode="" subnational1Code="" subnational2Code="">name of the subnational2 region </location> </result> </response> |