Collection Codes List API

API

URL	description	status	notes
ws/data/collections/list	Return entire list of collections	coded, not 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	csv xml	coded, not deployed	format to use for response; if an invalid format value is provided, the default is used

Test URLS

Development URL	Expected Response	Notes
http://localhost/ws/data/collections		What do we want here? 404? Redirect to /ws/data/collections/list?
http://localhost/ws/data/collections/list	entire list in CSV format	"csv" is the default format.
http://localhost/ws/data/collections/list?format=xml	entire list in XML format
http://localhost/ws/data/collections/list?format=csv	entire list in CSV format
http://localhost/ws/data/collections/list?format=QQQ	entire list in CSV format	Bad format value is ignored and defaulted to csv.
http://localhost/ws/data/collections/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/data/collections/list?format=	entire list in CSV format	Bad format value is ignored and defaulted to csv.

CSV Result Format

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