You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

CountryCode List and Search Web Service API

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

not coded

Test URLS

Development URL

Deployed URL

Expected Response

Notes

http://localhost/ws/ref/country

 

 

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

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

 

entire list in CSV format

"csv" is the default format.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1f2a0f43-3498-4415-ba7a-51b920133d31"><ac:plain-text-body><![CDATA[

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

 

entire list in XML format

 

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a2faed00-4719-40a6-9050-b2bf3c36af23"><ac:plain-text-body><![CDATA[

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

 

entire list in CSV format

 

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4741b9a8-ed9c-4223-af43-975e1427fc63"><ac:plain-text-body><![CDATA[

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

 

entire list in CSV format

Bad format value is ignored and defaulted to csv.

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fd7468db-00c4-429d-bfed-ed8e4f5cb974"><ac:plain-text-body><![CDATA[

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

 

entire list in CSV format

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

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="94004e9d-88d6-4b21-a830-5dbe24b41b7f"><ac:plain-text-body><![CDATA[

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

 

CSV list of 5 countries

 

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="451d617f-60f2-468f-9b4a-bcac8c0f10e7"><ac:plain-text-body><![CDATA[

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

 

XML list of 5 countries

 

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4761be22-eb10-4b11-9537-4edb60f8dc99"><ac:plain-text-body><![CDATA[

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

 

CSV list of 5 countries

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

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="58f8c95c-6efd-40f7-9e6f-54cc32886539"><ac:plain-text-body><![CDATA[

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

 

entire list in CSV format

Bad format value is ignored and defaulted to csv.

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="364749aa-5075-4286-beaa-2f631209ad1c"><ac:plain-text-body><![CDATA[

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

 

empty list in CSV format

 

]]></ac:plain-text-body></ac:structured-macro>

CSV Result Format

<country code>, <name associated with country code>
<country code>, <name associated with country code>
<country code>, <name associated with country code>

XML Result Format

<response>
  <header>
    <locale country="US" language="en"/>
    <timestamp>2008-02-21T12:37:32.546-05:00</timestamp>
    <criteria>
      <property name="match" value="something"/>
    </criteria>
    <comment>
    </comment>
  </header>
  <result>
    <location countryCode="" >name of the country </location>
    <location countryCode="" >name of the country </location>
    <location countryCode="" >name of the country </location>
</response>
  • No labels