Skip to main content

rupa/search

rupa search returns collections and search result urls.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://[domain]/api/status/index.xml?api_key=[api_key]

Example response:

<?xml version="1.0" encoding="utf-8"?>
<search total="0" per_page="10" pages="1" page="1">
    <link rel="alternate" href="results.php?q=" type="text/html"/>
    <link rel="search-within"
        href="http://{domain}/api/rupa/search.xml?pre_q="/>
    <link rel="date"
        href="http://{domain}/api/rupa/search.xml?sortBy=date"/>
    <collections>
        <search url="http://{domain}/api/rupa/collections/one/search.xml?">
            <name>Clearwater</name>
            <image src="/images/one.jpg"/>
        </search>
        <search url="http://{domain}/api/rupa/collections/two/search.xml?">
            <name>Test Collection one</name>
            <image src="/images/two.png"/>
        </search>
        <search url="http://{domain}/api/rupa/collections/three/search.xml?">
            <name>Caldwell 12 collection</name>
            <image src="/images/three.png"/>
        </search>
    </collections>
</search>