Suggestion — Provider API v0.6.7

GET /suggestions

Get Suggestions

Bearer token GetSuggestions

Get search suggestions for /work/search.

The query parameter should be the same as for /work/search.
and the filter parameter should be the same as for /work/search, but some search filter may not be working in suggestions, see which ones by calling configuration.

The response will be an array of suggestions of the type specified in the types parameter, and will be ordered by relevance.

Filters:

These only affects the suggestions of the type work:

plas.audience.literal
plas.audience.ageRange
plas.audience.ageGroup
plas.mediaTypes
plas.language
plas.subjects
plas.genres
plas.forms
plas.agent

Example request

cURL

curl -X GET "$PLAS_BASE_URL/suggestions?version=0.6.7" \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $PLAS_TOKEN"

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/suggestions?version=0.6.7`, {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": `Bearer ${process.env.PLAS_TOKEN}`,
  },
});
const data = await response.json();

Python

import os
import requests

response = requests.get(
    f"{os.environ['PLAS_BASE_URL']}/suggestions",
    params={
        "version": "0.6.7",
    },
    headers={
        "Accept": "application/json",
        "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
    },
)
data = response.json()

The host and token are environment variables: PLAS_BASE_URL the provider’s base URL · PLAS_TOKEN an access token.

Parameters

query: query · string
The suggestion (search) query.
Example: undset
size: query · integer
Suggestion size (default 10).
Example: 10
types: query · array of string
List of suggestion types allowed in result.
Example: query
filter: query · map of string
The suggestion (search) filter.
The possible keys in this map are the filters defined in the /configuration(/search) endpoint (field: (search->)suggestions->>available) and are a list of strings of the SearchFilterType type.
Example: {"filter-1":"Example filter"}

Shared across operations: ui_language, version. See the shared contract on the version page.

Responses

200 Success GetSuggestionsResponseBody

Generated from the schema

Example

{
  "suggestions": [
    {
      "query": "undset",
      "type": "query"
    }
  ]
}

Schema

GetSuggestionsResponseBody

suggestionsarray of Suggestionrequired
Show 4 variantsHide 4 variants
Selected by the field type
Variant: query
SuggestionTypeQuery
querystringrequired
typestringrequired
One of: query
Variant: contributor
SuggestionTypeContributor
contributorobjectrequired
typestringrequired
One of: contributor
Variant: work
SuggestionTypeWork
typestringrequired
One of: work
workobjectrequired
Variant: subject
SuggestionTypeSubject
subjectSubjectrequired
See Subject in the schema index
typestringrequired
One of: subject

400 The list of errors. Errors

Shared response, defined once for the whole API. See the shared contract on the version page.

Generated from the schema

Example

{
  "errors": [
    {
      "code": 200103,
      "info": "200103: invalid/unsupported query parameter value"
    }
  ]
}

Schema

Errors

errorsarray of Errorrequiredmin items 1
The first error should always be the most relevant.
Show 2 fieldsHide 2 fields
- codeintegerrequired
  A number representing the type of error.
  List of error codes:
  - \<error code\>: \<error description\>
  - 500: System error
  - 600: Unsupported Open Library API version
  - 10001: Endpoint disabled
  - 71001: Consent has not been given for 'loan history'
  - 100001: Wrong patron identifier, password or pin code
  - 100011: New password or pin code rejected, because it does not meet the provider's requirements
  - 100013: The provider does not let the patron change the given credential
  - 100023: Patron ID not found
  - 100101: Patron could not be deleted, because the patron has something unresolved issue with the library (this could be anything from a loan to a fee, and so on ...)
  - 100211: maxNumberOfEmailAddresses exceeded
  - 100215: maxNumberOfPhoneNumbers exceeded
  - 100221: Pickup location cannot contain sections
  - 100411: Updating patron consent failed
  - 100611: Updating patron notification settings failed
  - 101001: Reservation ID not found
  - 101047: Branch ID cannot be used as pick up branch
  - 101053: Section ID cannot be used as pick up branch
  - 102001: Loan ID not found
  - 102301: Loan not renewable, because it is an interlibrary loan
  - 102311: Loan not renewable, because it is reserved
  - 110001: Branch ID not found
  - 200001: Publication ID not found
  - 200077: ui language not supported
  - 200101: missing required query parameter
  - 200103: invalid/unsupported query parameter value
  - 300001: Initialize payment should not be used
  - 300005: Initialize payment should be used
  - 300009: Payment method not supported
  - 300013: Payment method does not support partial payment
  - 300301: Finalized payment can not de changed
  - 300311: FinalizePaymentRequest.fees contains fees with the same ID
  - 310001: Loan history ID not found
  - 310011: Loan history ID already exists
  - 330001: List ID not found
  - 330011: List ID already exists
  - 330101: List item ID not found
  - 330111: List item ID already exists
  One of: 500 · 600 · 10001 · 71001 · 100001 · 100011 · 100013 · 100023 · 100101 · 100211 · 100215 · 100221 · 100411 · 100611 · 101001 · 101047 · 101053 · 102001 · 102301 · 102311 · 110001 · 200001 · 200077 · 200101 · 200103 · 300001 · 300005 · 300009 · 300013 · 300301 · 300311 · 310001 · 310011 · 330001 · 330011 · 330101 · 330111
- infostringrequired
  Starts with the text matching the error code field (defined above), and a describing text could be added.

401 Bearer token invalid, missing, or expired.

Shared response, defined once for the whole API. See the shared contract on the version page.

No response body.

404 Resource not found.

Shared response, defined once for the whole API. See the shared contract on the version page.

No response body.