Configuration — Search API v0.6.7

GET /configuration/search

Get search configuration

Bearer-token GetSearchConfiguration

Eksempel på kald

cURL

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

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/configuration/search?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']}/configuration/search",
    params={
        "version": "0.6.7",
    },
    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

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

Svar

200 Success ConfigurationSearchResponseBody

Genereret ud fra skemaet

Eksempel

{
  "expression": {
    "clustering": [
      [
        {
          "type": "mediaTypes"
        },
        {
          "type": "language"
        },
        {
          "codes": [
            "trl"
          ],
          "type": "creatorsAndContributors"
        },
        {
          "codes": [
            "nrt"
          ],
          "type": "creatorsAndContributors"
        }
      ]
    ]
  },
  "suggestions": {
    "available": [
      {
        "description": "Only suggest titles for children.",
        "type": "plas.audience.literal"
      }
    ],
    "disabled": false
  },
  "uiLanguages": {
    "default": "nob",
    "supported": [
      "nob"
    ]
  },
  "workSearch": {
    "facet": {
      "available": [
        {
          "description": "Group the results by media type.",
          "type": "plas.audience.literal"
        }
      ]
    },
    "filter": {
      "available": [
        {
          "description": "Only show works available at the chosen branch.",
          "type": "plas.audience.literal"
        }
      ]
    },
    "sorting": {
      "available": [
        {
          "description": "Newest publications first.",
          "type": "plas.relevance.asc"
        }
      ]
    }
  }
}

Skema

ConfigurationSearchResponseBody

expressionConfigurationSearchExpression
Vis 1 feltSkjul 1 felt
- clusteringarray of array of ExpressionClusteringField
  This is the providers preferred clustering of publications.
  This clustering can be used to group publications together, emulating an expression level.
  Vis 5 varianterSkjul 5 varianter
  Vælges af feltet type
  Variant: creators
  ExpressionClusteringFieldNamedCreators
  Se ExpressionClusteringFieldNamedCreators i skema-indekset
  Variant: contributors
  ExpressionClusteringFieldNamedContributors
  Se ExpressionClusteringFieldNamedContributors i skema-indekset
  Variant: creatorsAndContributors
  ExpressionClusteringFieldNamedCreatorsAndContributors
  Se ExpressionClusteringFieldNamedCreatorsAndContributors i skema-indekset
  Variant: mediaTypes
  ExpressionClusteringFieldNamedMediaTypes
  Se ExpressionClusteringFieldNamedMediaTypes i skema-indekset
  Variant: language
  ExpressionClusteringFieldNamedLanguage
  Se ExpressionClusteringFieldNamedLanguage i skema-indekset
suggestionsConfigurationSearchSuggestions
Vis 2 felterSkjul 2 felter
- availablearray of ConfigurationSearchSuggestionsFilterAvailable
  This tells which filters are available for the /suggestions endpoint.
  Vis 2 felterSkjul 2 felter
  - descriptionstring
    This is a description of what type of filter this is.
  - typeSuggestionsFilterTypepåkrævet
    Filter type, this is the value given to the suggestions filter parameter.
    Én af: plas.audience.literal · plas.audience.ageRange · plas.audience.ageGroup · plas.mediaTypes · plas.language · plas.subjects · plas.genres · plas.forms
    Se SuggestionsFilterType i skema-indekset
- disabledboolean
  This tells the Vendor if the /suggestions endpoint is disabled or not. (Default false).
  If this is set to true, the Vendor should not make request to the /suggestions endpoint.
uiLanguagesobject
This contains the ui language settings.
All ui language codes should be on this list https://www.loc.gov/marc/languages/
Vis 2 felterSkjul 2 felter
- defaultstring
  This is the default ui language used if no language is added to the requests.
- supportedarray of string
  These are the supported ui languages that can be added to the requests.
workSearchobject
Vis 3 felterSkjul 3 felter
- facetConfigurationWorkSearchFacet
  Vis 1 feltSkjul 1 felt
  - availablearray of ConfigurationWorkSearchFacetAvailable
    Se ConfigurationWorkSearchFacetAvailable i skema-indekset
- filterConfigurationWorkSearchFilter
  Vis 1 feltSkjul 1 felt
  - availablearray of ConfigurationWorkSearchFilterAvailable
    Se ConfigurationWorkSearchFilterAvailable i skema-indekset
- sortingConfigurationWorkSearchSorting
  Vis 1 feltSkjul 1 felt
  - availablearray of ConfigurationWorkSearchSortingAvailable
    Se ConfigurationWorkSearchSortingAvailable i skema-indekset

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 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
  Én af: 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
- 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.