NCncl
V1
Digitised Objects
Search

Search digitised objects

Performs a keyword search with filters on the digitised objects present in the system.

get/v1/digitised-objects/search

Request

  • Base URL
    https://api-dor.ncl.ac.uk
  • Auth
    none declared

Query parameters

pagenumber

The pagination index, starting from 1 for the first page.

page.sizenumber

The number of items matching returned per page, between 1 and 100.

page.startnumber

The pagination starting offset starting from 0.

qstring

The main search phrase.

q.advancedstring

Query string dedicated to advanced searches, written in restricted Elasticsearch's query syntax.

sort'relevance' | 'title.asc' | 'title.desc' | 'date.asc' | 'date.desc' | 'createdAt.desc'

Determines the sorting method.

string
OR
string[]

List of collection titles that the items should belong to.

string
OR
string[]

List of collection ids that the items should belong to.

string
OR
string[]

List of subject terms that the items should belong to.

string
OR
string[]

List of thematic category terms that the items should belong to.

filter.date.fromnumber

The start of the date range query.

filter.date.tonumber

The end of the date range query.

string
OR
string[]

Determines whether returned items should have a TEI file related or not.

string
OR
string[]

Determines whether returned items should have a raw transcript file related or not.

scopestring
Example:digital.showcase

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",
      "refCode": "NUA/028944/02",
      "title": "Aerial view of main University campus and Newcastle city centre",
      "description": "Aerial view of university campus from the west including the Armstrong Building, Bedson Building, King George VI Building and Agriculture Building",
      "format": "Photograph",
      "_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.