Versions Compared

Old Version 22

changes.mady.by.user user-2d3e8

Saved on

compared with

New Version 23

changes.mady.by.user user-2d3e8

Saved on

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 "county" names. What kind of wildcards can be used?

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

one of countryCode and subnational1Code is required for /list

n/a


see CountryCode List and Search Web Service API

deployed

subnational1Code

one of countryCode and subnational1Code is required for /list

n/a


see AKN-1.0-Subnational1List

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

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

empty list in CSV format

Generates 404 error.

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

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

empty list in CSV format

 

http://localhost/ws/ref/subnational2/list?countryCode=US

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

entire list in CSV format

Country code in uppercase is valid.

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

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

empty list in CSV format

Country code in lowercase is invalid.

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

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

entire list in XML format

 

http://localhost/ws/ref/subnational2/list?countryCode=US&format=csv

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

entire list in CSV format

 

http://localhost/ws/ref/subnational2/list?countryCode=US&format=XML

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

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

entire list in CSV format

Bad format value is ignored and defaulted to csv.

http://localhost/ws/ref/subnational2/list?countryCode=US&format=QQQ

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

entire list in CSV format

Bad format value is ignored and defaulted to csv.

http://localhost/ws/ref/subnational2/list?subnational1Code=

http://www.avianknowledge.net/ws1.0/ref/subnational2/list?subnational1Code=

empty list in CSV format


http://localhost/ws/ref/subnational2/list?subnational1Code=US-NY

http://www.avianknowledge.net/ws1.0/ref/subnational2/list?subnational1Code=US-NY

entire list in CSV format

Subnational1 code in uppercase is valid.

http://localhost/ws/ref/subnational2/list?subnational1Code=us-ny

http://www.avianknowledge.net/ws1.0/ref/subnational2/list?subnational1Code=us-ny

empty list in CSV format

Subnational1 code in lowercase is invalid.

http://localhost/ws/ref/subnational2/list?subnational1Code=US-NY&format=xml

http://www.avianknowledge.net/ws1.0/ref/subnational2/list?subnational1Code=US-NY&format=xml

entire list in XML format

 

http://localhost/ws/ref/subnational2/find?match=clay

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

entire list in CSV format

 

http://localhost/ws/ref/subnational2/find?match=CLAY

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

entire list in CSV format

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

http://localhost/ws/ref/subnational2/find?match=clay&format=xml

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

entire list in XML format

 

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

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

empty list in CSV format

 

...