Search items
Performs a keyword search with filters on the items present in the system.
Request
- Base URLhttps://api-dor.ncl.ac.uk
- Authnone declared
Query parameters
The pagination index, starting from 1 for the first page.
The number of items matching returned per page, between 1 and 100.
The pagination starting offset starting from 0.
The main search phrase.
Query string dedicated to advanced searches, written in restricted Elasticsearch's query syntax.
Determines the sorting method.
List of collection titles that the items should belong to.
List of collection ids that the items should belong to.
List of digitised object titles that the items should belong to.
List of digitised object ids that the items should belong to.
List of subject terms that the items should belong to.
List of thematic category terms that the items should belong to.
The start of the date range query.
The end of the date range query.
Determines whether returned items should have a TEI file related or not.
Determines whether returned items should have a raw transcript file related or not.
Scopes query to return items assigned to the given system.
Response
The list of items matching the given search query.
Example response
{
"items": [
{
"id": "UkLWZg9D/3",
"position": 3,
"refCode": "Alderson Collection PAR PET",
"title": "Page 1",
"description": "First page of Chapter 1.",
"format": "Illustration",
"digitisedObject": {
"id": "UkLWZg9D",
"title": "Peter Parley's Visit to London During the Coronation of Queen Victoria",
"_links": {
"definition": {
"parameters": {
"?": "..."
}
}
}
},
"_links": {
"definition": {
"parameters": {
"?": "..."
}
}
}
}
],
"pagination": {
"_links": {
"first": {
"parameters": {
"?": "..."
}
},
"previous": {
"parameters": {
"?": "..."
}
},
"next": {
"parameters": {
"?": "..."
}
},
"last": {
"parameters": {
"?": "..."
}
}
}
},
"sort": {
"options": [
{
"_links": {
"activate": {
"parameters": {
"?": "..."
}
},
"deactivate": {
"parameters": {
"?": "..."
}
}
}
}
],
"active": {
"_links": {
"activate": {
"parameters": {
"?": "..."
}
},
"deactivate": {
"parameters": {
"?": "..."
}
}
}
},
"_links": {
"reset": {
"parameters": {
"?": "..."
}
}
}
},
"query": {
"_links": {
"deactivate": {
"parameters": {
"?": "..."
}
}
}
},
"filters": {
"options": [
{
"active": [
{
"_links": {
"activate": {
"parameters": {
"?": "..."
}
},
"deactivate": {
"parameters": {
"?": "..."
}
}
}
}
],
"facets": [
{
"_links": {
"activate": {
"parameters": {
"?": "..."
}
},
"deactivate": {
"parameters": {
"?": "..."
}
}
}
}
],
"_links": {
"reset": {
"parameters": {
"?": "..."
}
}
}
}
],
"_links": {
"reset": {
"parameters": {
"?": "..."
}
}
}
},
"_links": {
"home": {
"parameters": {
"?": "..."
}
},
"index": {
"parameters": {
"?": "..."
}
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.