Configuration

Example

{
  "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"
        }
      ]
    }
  }
}

Schema

ConfigurationSearchResponseBody

• expressionConfigurationSearchExpression
  Show 1 fieldHide 1 field

  • 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.

    Show 5 variantsHide 5 variants

    Selected by the field type

    Variant: creators

    ExpressionClusteringFieldNamedCreators

    See ExpressionClusteringFieldNamedCreators in the schema index

    Variant: contributors

    ExpressionClusteringFieldNamedContributors

    See ExpressionClusteringFieldNamedContributors in the schema index

    Variant: creatorsAndContributors

    ExpressionClusteringFieldNamedCreatorsAndContributors

    See ExpressionClusteringFieldNamedCreatorsAndContributors in the schema index

    Variant: mediaTypes

    ExpressionClusteringFieldNamedMediaTypes

    See ExpressionClusteringFieldNamedMediaTypes in the schema index

    Variant: language

    ExpressionClusteringFieldNamedLanguage

    See ExpressionClusteringFieldNamedLanguage in the schema index

• suggestionsConfigurationSearchSuggestions
  Show 2 fieldsHide 2 fields

  • availablearray of ConfigurationSearchSuggestionsFilterAvailable

    This tells which filters are available for the /suggestions endpoint.

    Show 2 fieldsHide 2 fields

    • descriptionstring

      This is a description of what type of filter this is.

    • typeSuggestionsFilterTyperequired

      Filter type, this is the value given to the suggestions filter parameter.

      One of: plas.audience.literal · plas.audience.ageRange · plas.audience.ageGroup · plas.mediaTypes · plas.language · plas.subjects · plas.genres · plas.forms

      See SuggestionsFilterType in the schema index

  • 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/

  Show 2 fieldsHide 2 fields

  • 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
  Show 3 fieldsHide 3 fields

  • facetConfigurationWorkSearchFacet
    Show 1 fieldHide 1 field

    • availablearray of ConfigurationWorkSearchFacetAvailable

      See ConfigurationWorkSearchFacetAvailable in the schema index

  • filterConfigurationWorkSearchFilter
    Show 1 fieldHide 1 field

    • availablearray of ConfigurationWorkSearchFilterAvailable

      See ConfigurationWorkSearchFilterAvailable in the schema index

  • sortingConfigurationWorkSearchSorting
    Show 1 fieldHide 1 field

    • availablearray of ConfigurationWorkSearchSortingAvailable

      See ConfigurationWorkSearchSortingAvailable in the schema index

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 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

    One of: 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

  • infostringrequired

    Starts with the text matching the error code field (defined above), and a describing text could be added.