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 |
|
format to use for response |
not coded |
Development URL |
Deployed URL |
Expected Response |
Notes |
||
|---|---|---|---|---|---|
|
|
What do we want here? 404? Redirect to /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="ae1011fd-6e7c-4af6-992e-bb9cfd7f633c"><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="2ac4aa2b-9a7a-4685-8359-e20e72252a6f"><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="448c9b3c-206c-41cd-9d48-afb75f16b808"><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="78444468-af19-43b7-a9fe-4d6e1ae39e2c"><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="8895adaf-a6a4-4d7a-a378-22869f541ea1"><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="51c77adc-d62d-4bad-893c-a3e96136db02"><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="17635c44-d27b-4cd3-8969-0719a64151b5"><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="51293260-0693-4c29-81a3-5af66f3eb5dd"><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="afb4b982-94f2-4b89-9739-7d61592e9c93"><ac:plain-text-body><![CDATA[ |
[http://localhost/ws/ref/][][country/][find?match=] |
|
empty list in CSV format |
|
]]></ac:plain-text-body></ac:structured-macro> |
|
<country code>, <name associated with country code> |
<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>
|