Versions Compared

Old Version 17

changes.mady.by.user Paul Allen

Saved on

compared with

New Version 18

changes.mady.by.user user-2d3e8

Saved on

Key

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

...

URL

description

status

notes

ws/ref/subnational1/list

Return entire list of "state" names

coded, not deployed

 

ws/ref/subnational1/list?countryCode=<2-letter ISO country code>

Return list of "state" names found in the given country

coded, not deployed

 

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

Return list of "state" names that match

coded, not deployed

Can 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 "county" 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

countryCode

no

n/a


2-letter ISO country code

coded, not deployed

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/subnational1  

http://www.avianknowledge.net/ws1.0/ref/subnational1

entire list in CSV format

Generates 404 error.

http://localhost What do we want here? 404? Redirect to /ws/ref/subnational1/list?

http://localhost/wswww.avianknowledge.net/ws1.0/ref/subnational1/list 

entire list in CSV format

"csv" is the default format.

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

http://www.avianknowledge.net/ws1.0/ref/subnational1/list?format=xml

entire list in XML format

 

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

http://www.avianknowledge.net/ws1.0/ref/subnational1/list?format=csv

entire list in CSV format

 

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

http://www.avianknowledge.net/ws1.0/ref/subnational1/list?format=QQQ

entire list in CSV format

Bad format value is ignored and defaulted to csv.

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

http://www.avianknowledge.net/ws1.0/ref/subnational1/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/subnational1/list?countryCode=US  

http://www.avianknowledge.net/ws1.0/ref/subnational1/list?countryCode=US

CSV list of states

Country code string in uppercase is valid.

http://localhost/ws/ref/subnational1/list?countryCode=US&format=xml
 

http://www.avianknowledge.net/ws1.0/ref/subnational1/list?countryCode=US&format=xml

XML list of states

 

http://localhost/ws/ref/subnational1/list?countryCode=us  

http://www.avianknowledge.net/ws1.0/ref/subnational1/list?countryCode=us

empty list in CSV format

Country code string in lowercase is invalid.

http://localhost/ws/ref/subnational1/list?countryCode=
 

http://www.avianknowledge.net/ws1.0/ref/subnational1/list?countryCode=

entire list in CSV format

 

http://localhost/ws/ref/subnational1/find?match=new  

http://www.avianknowledge.net/ws1.0/ref/subnational1/find?match=new

list of states in CSV format

 

http://localhost/ws/ref/subnational1/find?match=new&format=xml
 

http://www.avianknowledge.net/ws1.0/ref/subnational1/find?match=new&format=xml

list of states in XML format

 

http://localhost/ws/ref/subnational1/find?match=NEW  

http://www.avianknowledge.net/ws1.0/ref/subnational1/find?match=NEW

list of states in CSV format

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

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

http://www.avianknowledge.net/ws1.0/ref/subnational1/list?format=

entire list in CSV format

Bad format value is ignored and defaulted to csv.

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

http://www.avianknowledge.net/ws1.0/ref/subnational1/find?match=

empty list in CSV format

 

...