Suggestion — Provider API v0.6.4

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

Eksempel på kald

cURL

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

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/suggestions?version=0.6.4`, {
  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.4",
    },
    headers={
        "Accept": "application/json",
        "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
    },
)
data = response.json()

Værten og tokenet er miljøvariabler: PLAS_BASE_URL providerens adresse · PLAS_TOKEN et access token.

Parametre

query: query · string
The suggestion (search) query.
Eksempel: undset
size: query · integer
Suggestion size (default 10).
Eksempel: 10
types: query · array of string
List of suggestion types allowed in result.
Eksempel: 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.
Eksempel: {"filter-1":"Example filter"}

Fælles for operationerne: ui_language, version. Se den fælles kontrakt på versionssiden.

Svar

200 Success GetSuggestionsResponseBody

Genereret ud fra skemaet

Eksempel

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

Skema

GetSuggestionsResponseBody

suggestionsarray of Suggestionpåkrævet
Vis 4 varianterSkjul 4 varianter
Vælges af feltet type
Variant: query
SuggestionTypeQuery
querystringpåkrævet
typestringpåkrævet
Én af: query
Variant: contributor
SuggestionTypeContributor
contributorobjectpåkrævet
typestringpåkrævet
Én af: contributor
Variant: work
SuggestionTypeWork
typestringpåkrævet
Én af: work
workobjectpåkrævet
Variant: subject
SuggestionTypeSubject
subjectSubjectpåkrævet
Se Subject i skema-indekset
typestringpåkrævet
Én af: subject

400 The list of errors. Errors

Fælles svar, defineret én gang for hele API’et. Se den fælles kontrakt på versionssiden.

Genereret ud fra skemaet

Eksempel

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

Skema

Errors

errorsarray of Errorpåkrævetmin. antal 1
The first error should always be the most relevant.
Vis 2 felterSkjul 2 felter
- codeintegerpåkrævet
  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 username or password
  - 100023: Patron ID not found
  - 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
  Én af: 500 · 600 · 100001 · 100023 · 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
- infostringpåkrævet
  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.

Fælles svar, defineret én gang for hele API’et. Se den fælles kontrakt på versionssiden.

Intet indhold i svaret.

404 Resource not found.

Fælles svar, defineret én gang for hele API’et. Se den fælles kontrakt på versionssiden.

Intet indhold i svaret.