Versions Compared

Key

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

...

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


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

coded, not coded deployed.

Test URLS

Development URL

Deployed URL

Expected Response

Notes

http://localhost/ws/ref/bcr

 

 

What do we want here? 404? Redirect to /ws/ref/bcr/list?

http://localhost/ws/ref/bcr/list

 

entire list in CSV format

"csv" is the default format.

http://localhost/ws/ref/bcr/list?format=xml

 

entire list in XML format

 

http://localhost/ws/ref/bcr/list?format=csv

 

entire list in CSV format

 

http://localhost/ws/ref/bcr/list?format=QQQ

 

entire list in CSV format

Bad format value is ignored and defaulted to csv.

http://localhost/ws/ref/bcr/list?format=XML

 

entire list in CSV format

"XML" is not a valid format option. Only "xml" and "csv" are valid options.

http://localhost/ws/ref/bcr/find?match=mountain

 

CSV list of 2 BCRs

 

http://localhost/ws/ref/bcr/find?match=mountain&format=xml

 

XML list of 2 BCRs

 

http://localhost/ws/ref/bcr/find?match=MOUNTAIN

 

CSV list of 2 BCRs

There should be no difference in response for upper/lower case search strings.

http://localhost/ws/ref/bcr/list?format=

 

entire list in CSV format

Bad format value is ignored and defaulted to csv.

http://localhost/ws/ref/bcr/find?match=

 

empty list in CSV format

 

...