Panel | |
---|---|
|
Subnational2Code List and Search Web Service API
API
This functionality is contained in the IS/DataDeliveryREST code base.
URL | description | status | notes |
---|---|---|---|
data/subnational2/list?locale=<locale to use for names> | Return entire list of "county" names |
| |
data ws/ref/subnational2/list?countryCode=<2-letter ISO country code> &locale=<locale to use for names> | Return list of "county" names found in the given country | deployed |
|
data ws/ref/subnational2/find?qmatch=<string to match> &locale=<locale used in match string> | Return list of "county" names that match | deployed | Can wildcards be used in the match string? No wildcard yet implemented. |
ws/ref data/subnational2/list?subnational1Code=<eBird subnational1 code>&locale=<locale to use for names> <subnational1 code> | Return list of "county" names found in the given "state" | 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? | 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 no | one of countryCode and subnational1Code is required for /list | n/a | see CountryCode List and Search Web Service API | deployed | ||||
subnational1Code | one of countryCode and subnational1Code is required for /list | 2-letter ISO country code | subnational1Code | no | n/a | deployed eBird standard subnational1Code | ||
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="locIDs="match" value="seomthing"/> <property name="subnational1Code" value="seomthing"/> <property name="countryCode" value="[L97555]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> </responseresponse> |