V1
Digitised Objects
Search
Autocomplete

Search digitised objects autocompletion

Provides search box autocompletion for the given phrase.

get/v1/digitised-objects/search/autocomplete

Request

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

Query parameters

qstring required

The search phrase that should be autocompleted.

page.sizenumber

The maximum number of items returned, between 1 and 25 (by default it is 10).

scopestring
Example:digital.showcase

Scopes query to return items assigned to the given system.

Response

The list of terms/phrases matching the given query.

Example response

{
  "items": [
    {
      "title": "Photograph taken by Gertrude Bell showing Delhi, India",
      "highlight": "Photograph taken by <mark>Gertrude Bell</mark> showing Delhi, India"
    }
  ],
  "_links": {
    "search": {
      "parameters": {
        "?": "..."
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.