Skip to main content

rupa/collections

Retrieves all configured search collections as defined within the Rupa module.

Arguments:

  • api_key (required)

Example request:

http://[domain]/api/rupa/collections.xml?api_key=[api_key]

Example response:

<?xml version="1.0" encoding="utf-8"?>
<collections pages="1" page="1" total="3">
<collection>
<name>Clearwater</name>
<collection_name>one</collection_name>
<image>http://mysite.co.uk/images/one.jpg</image>
</collection>
<collection>
<name>Test Collection one</name>
<collection_name>two</collection_name>
<image>http://mysite.co.uk/images/two.png</image>
</collection>
<collection>
<name>Caldwell 12 collection</name>
<collection_name>three</collection_name>
<image>http://mysite.co.uk/images/three.png</image>
</collection>
</collections>