Child pages
  • External Access API
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 34 Current »

Using the OpenSearch 1.1 specification, and the following OpenSearchDescription, external entities may perform searches on our databases.

<?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
    <ShortName>Scholars Portal Search</ShortName>
    <Description>Use api.scholarsportal.info to search our repository of electronic journals.</Description>
    <Url type="application/atom+xml"
        template="http://api.scholarsportal.info/journals/opensearch/1.1/search.xqy/?q={searchTerms}&p={startPage?}&c={count?}"/>
    <Contact>api@scholarsportal.info</Contact>
    <Query role="example" searchTerms="water"/>
    <SyndicationRight>limited</SyndicationRight>
    <AdultContent>false</AdultContent>
    <InputEncoding>UTF-8</InputEncoding>
    <OutputEncoding>UTF-8</OutputEncoding>
</OpenSearchDescription>

Results will be generated Atom feeds (see Atom format and protocol).

As indicated by the OpenSearchDescription, the api will look for three parameters: q, p, and c:

q – the search query (required)
p – the result page number to return (optional, defaults to 1)
c – the number of results per page to return (optional, defaults to 10)

Here is an example HTTP query:

http://api.scholarsportal.info/journals/opensearch/1.1/search.xqy?q=water

And the resulting xml, illustrating the structure of the response:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:os="http://a9.com/-/spec/opensearch/1.1/"
    xmlns:sp="http://scholarsportal.info/metadata">
    <id>http://api.scholarsportal.info/journals/opensearch/1.1/</id>
    <title>OCUL Scholars Portal EJournals OpenSearch 1.1</title>
    <updated>2009-07-20T18:38:40.448072-04:00</updated>
    <link rel="self"
        href="http://api.scholarsportal.info/journals/opensearch/1.1/search.xqy?q=water&amp;p=1&amp;c=10"/>
    <link rel="next"
        href="http://api.scholarsportal.info/journals/opensearch/1.1/search.xqy?q=water&amp;p=2&amp;c=10"/>
    <author>
        <name>OCUL Scholars Portal</name>
        <email>info@scholarsportal.info</email>
        <uri>http://www.scholarsportal.info</uri>
    </author>
    <os:totalResults>932027</os:totalResults>
    <os:itemsPerPage>10</os:itemsPerPage>
    <os:Query role="request" searchTerms="water" startPage="1" count="10"/>
    <entry>
        <id>http://journals.scholarsportal.info/details.xqy?uri=/03783774/v95i0009/1067_cooiofgrrcit.xml</id>
        <title>Challenges of optimal implementation of formal water rights systems for irrigation in
            the Great Ruaha River Catchment in Tanzania</title>
        <updated>2008-09-01T00:00:00Z</updated>
        <link rel="alternate"
            href="http://journals.scholarsportal.info/details.xqy?uri=/03783774/v95i0009/1067_cooiofgrrcit.xml"/>
        <content type="application/xml">
            <result n="1" xmlns="http://scholarsportal.info/metadata">
                <article>
                    <id>/03783774/v95i0009/1067_cooiofgrrcit</id>
                    <link rel="alternate"
                        href="http://journals.scholarsportal.info/details.xqy?uri=/03783774/v95i0009/1067_cooiofgrrcit.xml"/>
                    <title>Challenges of optimal implementation of formal water rights systems for
                        irrigation in the Great Ruaha River Catchment in Tanzania</title>
                    <type>research-article</type>
                    <publication-date>2008-09-01</publication-date>
                    <load-date>2009-05-02</load-date>
                    <authors>
                        <author>
                            <givenname>Kossa R.M.</givenname>
                            <surname>Rajabu</surname>
                        </author>
                        <author>
                            <givenname>Henry F.</givenname>
                            <surname>Mahoo</surname>
                        </author>
                    </authors>
                    <keywords>
                        <keyword>Over-abstraction</keyword>
                        <keyword>Water management</keyword>
                        <keyword>Water right grant</keyword>
                        <keyword>Water use permit</keyword>
                        <keyword>Water users’ fees</keyword>
                    </keywords>
                </article>
                <journal>
                    <issn-ppub>03783774</issn-ppub>
                    <issn-epub/>
                    <link rel="alternate"
                        href="http://journals.scholarsportal.info/journal.xqy?uri=/03783774"/>
                    <title>Agricultural Water Management</title>
                    <volume>95</volume>
                    <issue>9</issue>
                    <publisher>Elsevier</publisher>
                </journal>
            </result>
        </content>
    </entry>
    <entry>
        ...
    </entry>
    <entry>
        ...
    </entry>
    ....
</feed>
  • No labels