Collection Codes List API
API
URL |
description |
status |
notes |
---|---|---|---|
ws/data/collections/list |
Return entire list of collections |
deployed |
|
parameter |
required |
default |
value options |
implementation status |
description |
---|---|---|---|---|---|
locale |
no |
en_US |
Java standard locale codes |
not implemented |
locale in which to provide names in response (when possible); if an invalid locale value is provided in the request, the default value is used |
format |
no |
csv |
|
deployed |
format to use for response; if an invalid format value is provided, the default is used |
Test URLS
Development URL |
Deployed URL |
Expected Response |
Notes |
---|---|---|---|
|
Generates 404 error. |
||
entire list in CSV format |
"csv" is the default format. |
||
entire list in XML format |
|
||
entire list in CSV format |
|
||
entire list in CSV format |
Bad format value is ignored and defaulted to csv. |
||
entire list in CSV format |
"XML" is not a valid format option. Only "xml" and "csv" are valid options. |
||
entire list in CSV format |
Bad format value is ignored and defaulted to csv. |
CSV Result Format
<data service code>, <collection code>, <name associated with collection>
<data service code>, <collection code>, <name associated with collection>
<data service code>, <collection code>, <name associated with collection>
<data service code>, <collection code>, <name associated with collection>
XML Result Format
<response> <header> <locale country="US" language="en"/> <timestamp>2008-02-21T12:37:32.546-05:00</timestamp> <criteria> <property name="" value=""/> </criteria> <comment> </comment> </header> <result> <collection code="" >name of the collection </collection> <collection code="" >name of the collection </collection> <collection code="" >name of the collection </collection> </result> </response