Holding — Provider API v0.6.7

GET /holdings

Get holdings

Bearer-token GetHoldings

Eksempel på kald

cURL

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

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/holdings?publication_ids=310552&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']}/holdings",
    params={
        "publication_ids": "310552",
        "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

publication_idspåkrævet: query · array of string
A list of publication IDs, each publication ID should be url encoded and separated by a comma.
Eksempel: 310552
show_to: query · array of string
A list of show_to values, where each value is url encoded and separated by a comma.
This tells the provider that the returned data is intended to be shown to a specific group of users, and all returned data must be filtered appropriately.
If no groups are given, all data should be returned.
Eksempel: public
patron_id: query · string
The patron ID of the active patron.
Eksempel: 40218873

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

Svar

200 The response will contain a mapping from each publication ID to an array of holdings. GetHoldingResponseBody

If a publication ID represents a periodical, there can be from zero to many holdings for that publication ID, and each holding will represent a unique issue of that periodical.

If a publication ID does not represent a periodical, there can be from zero to one holding for that publication ID.

Genereret ud fra skemaet

Eksempel

{
  "holdings": {
    "holding-310552": [
      {
        "locations": [
          {
            "items": [
              {
                "availableState": "available",
                "itemId": "03011042557129",
                "lendingDays": 28,
                "loanableState": "loanable",
                "pickupLocations": [
                  {
                    "branchId": "nordby-main",
                    "branchName": "Nordby Main Library",
                    "sections": [
                      {
                        "id": "nordby-main-children",
                        "name": "Children’s department",
                        "type": "department"
                      }
                    ]
                  }
                ],
                "reserveId": "7730015"
              }
            ],
            "location": {
              "branchId": "nordby-main",
              "branchName": "Nordby Main Library",
              "path": [
                {
                  "id": "nordby-main-children",
                  "name": "Children’s department",
                  "type": "department"
                }
              ]
            },
            "pickupLocations": [
              {
                "branchId": "nordby-main",
                "branchName": "Nordby Main Library",
                "sections": [
                  {
                    "id": "nordby-main-children",
                    "name": "Children’s department",
                    "type": "department"
                  }
                ]
              }
            ],
            "shelfmark": "839.82 Und"
          }
        ],
        "numberOfReservations": 5,
        "periodical": {
          "grouping": [
            {
              "type": "year",
              "value": "2025"
            }
          ],
          "name": "Kari Nordmann"
        },
        "publicationId": "310552",
        "reserveId": "7730015"
      }
    ]
  }
}

Skema

GetHoldingResponseBody

holdingsmap of array of Holdingpåkrævet
Vis 1 feltSkjul 1 felt
- vilkårlig nøglearray of Holding
  Vis 5 felterSkjul 5 felter
  - locationsarray of HoldingLocationpåkrævet
    Se HoldingLocation i skema-indekset
  - numberOfReservationsinteger
    This tells how many reservations there exist on the publication (or periodical).
    If this is unknown, the field is not set.
  - periodicalHoldingPeriodical
    Se HoldingPeriodical i skema-indekset
  - publicationIdstringpåkrævet
    The publication ID
  - reserveIdstringpåkrævet
    This is the Reserve ID to be used for reserving this publication (or periodical). If this is empty, the publication (or periodical) is not reservable.
    If the holding represents a periodical, this reserve ID is still all that is required to reserve that issue.

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.