*** This version of Confluence is for testing only and contains a copy of content from June 29th 2026. No changes will be preserved. ***
| Panel | |
|---|---|
|
Bird Conservaiton Region (BCR) Code List and Search Web Service API
API
URL | description | status | notes |
|---|---|---|---|
ws/ref/bcr/list | Return list of all BCRs | coded, not deployed |
|
ws/ref/bcr/list?countryCode=<2-letter ISO country code> | Return list of BCRs found in the given country | not coded; need info about country and BCR intersections in DB before coding this | |
ws/ref/bcr/find?match=<string to match> | Return list of BCRs that match | coded, not deployed | What wildcards be used in the match string? No wildcards yet implemented. |
ws/ref/bcr/list?subnational1Code=<subnational1 code> | Return list of BCRs found in the given "state" | not coded; need info about state and BCR intersections in DB before coding this |
|
parameter | required | default | value options | description | status |
|---|---|---|---|---|---|
match | yes, for /find | n/a |
| string to match against BCR names; What wildcards can be used? | coded, not deployed. No wildcards 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; if a countryCode and subnational1Code are specified for the same request, the countryCode is ignored | n/a | not coded | ||
subnational1Code | no; if a countryCode and subnational1Code are specified for the same request, the countryCode is ignored | n/a | not coded | ||
format | no | csv |
| format to use for response | not coded |
Test URLS
CSV Result Format
| Panel |
|---|
<BCR code>, <name associated with BCR> |
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"/>
<property name="subnational1Code" value="something"/>
<property name="countryCode" value="something"/>
</criteria>
<comment>
</comment>
</header>
<result>
<location bcrCode="">name of the BCR region </location>
<location bcrCode="">name of the BCR region </location>
<location bcrCode="">name of the BCR region </location>
</result>
</response>
|