Versions Compared

Key

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

...

URL

description

status

notes

ws/ref/country/list

Return entire list of country names and codes

coded, not deployed

 

ws/ref/country/find?match=<string to match>

Return list of country names and their codes that match

coded, not deployed

What wildcards be used in the match string? No wildcard yet implemented.

parameter

required

default

value options

description

status

match

yes, for /find

n/a

 

String to match against "country" names. What kind of wildcards can be used?

coded, not 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

format

no

csv

  • csv
  • xml

format to use for response

coded, not deployed

Test URLS

Development URL

Deployed URL

Expected Response

Notes

http://localhost/ws/ref/country

 http://localhost/ws/ref/country

entire list in CSV format

What do we want here? Generates 404? Redirect to

http://localhost/ws/ref/country/list?

http://localhost/ws/ref/country/list

 

entire list in CSV format

"csv" is the default format.

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

 http://localhost/ws/ref/country

entire list in XML format

 

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

 http://localhost/ws/ref/country

entire list in CSV format

 

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

 http://localhost/ws/ref/country

entire list in CSV format

Bad format value is ignored and defaulted to csv.

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

 http://localhost/ws/ref/country

entire list in CSV format

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

http://localhost/ws/ref/country/find?match=united

 

list of countries in CSV format

 

http://localhost/ws/ref/country/find?match=united&format=xml

 

XML list of countries

 

http://localhost/ws/ref/country/find?match=UNITED

 

list of countries in CSV format

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

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

 

entire list in CSV format

Bad format value is ignored and defaulted to csv.

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

 

empty list in CSV format

 

...