Author: |
Cenit IO |
License: |
no license |
Branch: |
8.0 |
Repository: |
andhit-r/odoo-integrations |
Dependencies: |
base,
and
cenit_base |
Languages: |
HTML (38, 7.6%),
Python (67, 13.5%),
and
XML (393, 78.9%) |
<p style="text-align: justify;">This is a documentation for CORE API v2.0. The CORE API is the programming
interface to <a href="http://core-project.kmi.open.ac.uk/">CORE</a>. You can use the API to access the
resources harvested and enriched by CORE. The API described here is currently in beta. If you
encounter any problems with the API, please report them to us.</p>
<h2>Overview</h2>
<p style="text-align: justify;">The API is organised by resource type. The resources are <b>articles</b>,
<b>journals</b> and <b>repositories</b> and are represented using JSON data format. Furthermore,
each resource has a list of methods. The API also provides two global methods for accessing all resources at once.</p>
<h2>Response format</h2>
<p style="text-align: justify;">Response for each query contains two fields: <b>status</b> and <b>data</b>.
In case of an error status, the data field is empty. The data field contains a single object
in case the request is for a specific identifier (e.g. CORE ID, CORE repository ID, etc.), or
contains a list of objects, for example for search queries. In case of batch requests, the response
is an array of objects, each of which contains its own <b>status</b> and <b>data</b> fields.
For search queries the response contains an additional field <b>totalHits</b>, which is the
total number of items which match the search criteria.</p>
<h2>Search query syntax</h2>
<p style="text-align: justify">All of the API search methods allow using complex search queries.
The query can be a simple string or it can be built using terms and operators described in Elasticsearch
<a href="http://www.elastic.co/guide/en/elasticsearch/reference/1.4/query-dsl-query-string-query.html#query-string-syntax">documentation</a>.
The usable field names are <strong>title</strong>, <strong>description</strong>, <strong>fullText</strong>,
<strong>authorsString</strong>, <strong>publisher</strong>, <strong>repositoryIds</strong>, <strong>doi</strong>,
<strong>identifiers</strong> (which is a list of article identifiers including OAI, URL, etc.), <strong>language.name</strong>
and <strong>year</strong>. Some example queries:
</p>
<ul style="margin-left: 30px;">
<li><p>title:psychology and language.name:English</p></li>
<li><p>repositoryIds:86 AND year:2014</p></li>
<li><p>identifiers:"oai:aura.abdn.ac.uk:2164/3837" OR identifiers:"oai:aura.abdn.ac.uk:2164/3843"</p></li>
<li><p>doi:"10.1186/1471-2458-6-309"</p></li>
</ul>
<h2>Sort order</h2>
<p style="text-align: justify;">For search queries, the results are ordered by relevance score. For batch
requests, the results are retrieved in the order of the requests.</p>
<h2>Parameters</h2>
<p style="text-align: justify;">The API methods allow different parameters to be passed. Additionally, there is an API key parameter which is common to all API methods. For all API methods
the API key can be provided either as a query parameter or in the request header. If the API key
is not provided, the API will return HTTP 401 error. You can register for an API key <a href="/intro/api">here</a>.</p>
<h2>API methods</h2>
Show more...