Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URL

description

status

notes

ws/ref/bcr/list

Return list of all BCRs

not coded

 

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

not coded

What wildcards be used in the match string?

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?

not coded

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


see CountryCode List and Search Web Service API

not coded

subnational1Code

no; if a countryCode and subnational1Code are specified for the same request, the countryCode is ignored

n/a


see Subnational1Code List and Search Web Service API

not coded

format

no

csv

  • csv
  • xml

format to use for response

not coded

...