Patron Loan

View as Markdown The page’s .md file llms.txt All pages, for AI tools Open in ChatGPT Ask questions about the page Open in Claude Ask questions about the page

No description in the specification.

2 operations

GET /patron/{patronId}/loan

Get patron loans

Bearer token GetPatronLoans

Example request

cURL

curl -X GET "$PLAS_BASE_URL/patron/40218873/loan?version=0.6.6" \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $PLAS_TOKEN"

JavaScript

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

patronIdrequired: path · string
Patron ID from authentication
Example: 40218873

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

Responses

200 Success PatronLoanResponseBody

Generated from the schema

Example

{
  "loans": [
    {
      "acquiredFrom": {
        "type": "local_circulation"
      },
      "createdTime": "2025-03-14T10:24:00+01:00",
      "dueDate": "2025-04-11",
      "id": "94549",
      "itemId": "03011042557129",
      "location": {
        "branchId": "nordby-main",
        "sections": [
          {
            "id": "nordby-main-children",
            "name": "Children’s department",
            "type": "department"
          }
        ]
      },
      "publicationId": "310552",
      "publicationMetadata": {
        "additionalIdentifiers": [
          {
            "digits": "10",
            "type": "isbn",
            "value": "9788203363344"
          }
        ],
        "binding": {
          "type": "literal",
          "value": "Hardback"
        },
        "contributors": [
          {
            "agent": {
              "description": "Norwegian novelist, awarded the Nobel Prize in Literature in 1928.",
              "fullName": "Sigrid Undset",
              "id": "agent-4102",
              "images": [
                {
                  "height": 1200,
                  "mime": "png",
                  "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
                  "width": 800,
                  "type": "agent"
                }
              ],
              "active": {
                "type": "literal",
                "value": "1882-1949"
              },
              "birthDate": {
                "type": "literal",
                "value": "1920"
              },
              "deathDate": {
                "type": "literal",
                "value": "1920"
              },
              "externals": {
                "identifiers": [
                  {
                    "type": "norwegianAuthorityFile",
                    "value": "4102"
                  }
                ]
              },
              "givenName": "Kari",
              "surname": "Nordmann",
              "type": "person"
            },
            "roles": [
              {
                "roleCode": "aut",
                "type": "marcRelator"
              }
            ]
          }
        ],
        "creators": [
          {
            "agent": {
              "description": "Norwegian novelist, awarded the Nobel Prize in Literature in 1928.",
              "fullName": "Sigrid Undset",
              "id": "agent-4102",
              "images": [
                {
                  "height": 1200,
                  "mime": "png",
                  "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
                  "width": 800,
                  "type": "agent"
                }
              ],
              "active": {
                "type": "literal",
                "value": "1882-1949"
              },
              "birthDate": {
                "type": "literal",
                "value": "1920"
              },
              "deathDate": {
                "type": "literal",
                "value": "1920"
              },
              "externals": {
                "identifiers": [
                  {
                    "type": "norwegianAuthorityFile",
                    "value": "4102"
                  }
                ]
              },
              "givenName": "Kari",
              "surname": "Nordmann",
              "type": "person"
            },
            "roles": [
              {
                "roleCode": "aut",
                "type": "marcRelator"
              }
            ]
          }
        ],
        "edition": {
          "type": "literal",
          "value": "2nd edition"
        },
        "extent": [
          {
            "type": "literal",
            "value": "312 pages"
          }
        ],
        "identifier": "310552",
        "images": [
          {
            "height": 1200,
            "mime": "png",
            "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
            "width": 800,
            "type": "frontCover"
          }
        ],
        "language": [
          {
            "code": "SplxlOBeZQQYbYS6WxSbIA",
            "name": "Kari Nordmann"
          }
        ],
        "mediaTypes": [
          {
            "code": "book",
            "name": "Kari Nordmann"
          }
        ],
        "publicationDate": {
          "type": "literal",
          "value": "1920"
        },
        "publishers": [
          {
            "places": [
              {
                "place": "Oslo"
              }
            ],
            "publisher": {
              "id": "94549",
              "name": "Kari Nordmann"
            }
          }
        ],
        "titles": [
          {
            "language": {
              "code": "SplxlOBeZQQYbYS6WxSbIA",
              "name": "Kari Nordmann"
            },
            "main": "Kristin Lavransdatter",
            "part": {
              "name": "Kari Nordmann",
              "number": "1"
            },
            "remainder": "The Wreath",
            "type": "preferred"
          }
        ],
        "works": [
          {
            "identifier": "882107",
            "relation": "contains"
          }
        ]
      },
      "renew": {
        "count": 2,
        "lastDate": "2025-03-14",
        "state": "renewable"
      }
    }
  ]
}

Schema

PatronLoanResponseBody

loansarray of PatronLoanrequired
Show 9 fieldsHide 9 fields
- acquiredFromPatronLoanAcquiredFrom
  This tells from where (the material for) this loan was acquired.
  If this field are missing, the default value local_circulation should be assumed.
  - local_circulation: Meaning that this loan was acquired from the customers own inventory.
  - interlibrary_loan: Meaning that this loan was acquired as a interlibrary loan.
  - unknown: Meaning that this information is unknown.
  Show 3 variantsHide 3 variants
  Selected by the field type
  Variant: local_circulation
  PatronLoanAcquiredFromTypeLocalCirculation
  See PatronLoanAcquiredFromTypeLocalCirculation in the schema index
  Variant: interlibrary_loan
  PatronLoanAcquiredFromTypeInterlibraryLoan
  See PatronLoanAcquiredFromTypeInterlibraryLoan in the schema index
  Variant: unknown
  PatronLoanAcquiredFromTypeUnknown
  See PatronLoanAcquiredFromTypeUnknown in the schema index
- createdTimestring (date-time)required
  The date and time the loan was made.
- dueDatestring (date)required
  The latest date on which the loan must be returned.
- idstringrequired
  This is the loan ID.
- itemIdstringrequired
  This is the item identifier of the checkout item.
- locationCheckOutOrInLocationWithoutNames
  Show 2 fieldsHide 2 fields
  - branchIdstringrequired
    The branch ID where the checkout or checkin was made.
  - sectionsarray of LocationSectionElementWithIdNameAndType
    This is specifying the location more precisely.
    See LocationSectionElementWithIdNameAndType in the schema index
- publicationIdstringrequired
  This is the publication ID of the loan. If this is empty, the publication is unknown.
- publicationMetadataPublicationFallback
  This metadata is only intended as fallback data, for when the provider is not able to serve the metadata through the GET /publication endpoint.
  This can for some provider be the case when working with e.g. interlibrary loans.
  Show 14 fieldsHide 14 fields
  - additionalIdentifiersarray of AdditionalIdentifier
    Other identifiers, like: ISBN, ISSN, ...
    See PublicationAdditionalIdentifiers in the schema index
  - bindingBinding
    See Binding in the schema index
  - contributorsarray of Contributor
    The contributor(s) to the publication.
    See PublicationContributors in the schema index
  - creatorsarray of Contributor
    The creator(s) of the publication.
    See PublicationCreators in the schema index
  - editionEdition
    See Edition in the schema index
  - extentarray of Extent
    Together all the Extents in the array describes the total extent of the publication.
    See PublicationExtent in the schema index
  - identifierstringrequired
    Publication identifier. This is searchable through the GET /publication endpoint.
  - imagesarray of ImagePublication
    Images to use with the publication.
    See PublicationImages in the schema index
  - languagearray of Language
    This is the language(s) of the this publication. If the publication uses multi languages this will also contain them.
    See PublicationLanguage in the schema index
  - mediaTypesarray of MediaType
    See PublicationMediaTypes in the schema index
  - publicationDateDate
    Date of publication.
    See Date in the schema index
  - publishersarray of PublisherAndPlaces
    List of publishers and associated place(s) of publication.
    See PublisherAndPlaces in the schema index
  - titlesarray of Titlerequiredmin items 1
    Title of the publication.
    See PublicationTitles in the schema index
  - worksarray of PublicationWorkrequired
    See PublicationWork in the schema index
- renewLoanRenewInforequired
  Show 3 fieldsHide 3 fields
  - countintegermin 0
    The number of times this loan can still be renewed. If the field is missing, this information is unknown.
  - lastDatestring (date)
    The date when the loan was last renewed. If the field is missing, this information is unknown.
  - statestringrequired
    This tells the renewable state of the loan.
    One of: renewable · not_renewable · renewable_later · unknown

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 username or password
  - 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 · 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.

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.

PUT /patron/{patronId}/loan/{loanId}

Renew loan

Bearer token RenewPatronLoan

Renew a loan

Example request

cURL

curl -X PUT "$PLAS_BASE_URL/patron/40218873/loan/58210447?version=0.6.6" \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $PLAS_TOKEN"

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/patron/40218873/loan/58210447?version=0.6.6`, {
  method: "PUT",
  headers: {
    "Accept": "application/json",
    "Authorization": `Bearer ${process.env.PLAS_TOKEN}`,
  },
});
const data = await response.json();

Python

import os
import requests

response = requests.put(
    f"{os.environ['PLAS_BASE_URL']}/patron/40218873/loan/58210447",
    params={
        "version": "0.6.6",
    },
    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

patronIdrequired: path · string
Patron ID from authentication
Example: 40218873
loanIdrequired: path · string
ID of the loan that is to be renewed
Example: 58210447

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

Responses

200 It is important to check the returned status field, to distinguish between success and the different failure statuses. RenewPatronLoanResponseBody

Generated from the schema

Example

{
  "loan": {
    "acquiredFrom": {
      "type": "local_circulation"
    },
    "createdTime": "2025-03-14T10:24:00+01:00",
    "dueDate": "2025-04-11",
    "id": "94549",
    "itemId": "03011042557129",
    "location": {
      "branchId": "nordby-main",
      "sections": [
        {
          "id": "nordby-main-children",
          "name": "Children’s department",
          "type": "department"
        }
      ]
    },
    "publicationId": "310552",
    "publicationMetadata": {
      "additionalIdentifiers": [
        {
          "digits": "10",
          "type": "isbn",
          "value": "9788203363344"
        }
      ],
      "binding": {
        "type": "literal",
        "value": "Hardback"
      },
      "contributors": [
        {
          "agent": {
            "description": "Norwegian novelist, awarded the Nobel Prize in Literature in 1928.",
            "fullName": "Sigrid Undset",
            "id": "agent-4102",
            "images": [
              {
                "height": 1200,
                "mime": "png",
                "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
                "width": 800,
                "type": "agent"
              }
            ],
            "active": {
              "type": "literal",
              "value": "1882-1949"
            },
            "birthDate": {
              "type": "literal",
              "value": "1920"
            },
            "deathDate": {
              "type": "literal",
              "value": "1920"
            },
            "externals": {
              "identifiers": [
                {
                  "type": "norwegianAuthorityFile",
                  "value": "4102"
                }
              ]
            },
            "givenName": "Kari",
            "surname": "Nordmann",
            "type": "person"
          },
          "roles": [
            {
              "roleCode": "aut",
              "type": "marcRelator"
            }
          ]
        }
      ],
      "creators": [
        {
          "agent": {
            "description": "Norwegian novelist, awarded the Nobel Prize in Literature in 1928.",
            "fullName": "Sigrid Undset",
            "id": "agent-4102",
            "images": [
              {
                "height": 1200,
                "mime": "png",
                "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
                "width": 800,
                "type": "agent"
              }
            ],
            "active": {
              "type": "literal",
              "value": "1882-1949"
            },
            "birthDate": {
              "type": "literal",
              "value": "1920"
            },
            "deathDate": {
              "type": "literal",
              "value": "1920"
            },
            "externals": {
              "identifiers": [
                {
                  "type": "norwegianAuthorityFile",
                  "value": "4102"
                }
              ]
            },
            "givenName": "Kari",
            "surname": "Nordmann",
            "type": "person"
          },
          "roles": [
            {
              "roleCode": "aut",
              "type": "marcRelator"
            }
          ]
        }
      ],
      "edition": {
        "type": "literal",
        "value": "2nd edition"
      },
      "extent": [
        {
          "type": "literal",
          "value": "312 pages"
        }
      ],
      "identifier": "310552",
      "images": [
        {
          "height": 1200,
          "mime": "png",
          "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
          "width": 800,
          "type": "frontCover"
        }
      ],
      "language": [
        {
          "code": "SplxlOBeZQQYbYS6WxSbIA",
          "name": "Kari Nordmann"
        }
      ],
      "mediaTypes": [
        {
          "code": "book",
          "name": "Kari Nordmann"
        }
      ],
      "publicationDate": {
        "type": "literal",
        "value": "1920"
      },
      "publishers": [
        {
          "places": [
            {
              "place": "Oslo"
            }
          ],
          "publisher": {
            "id": "94549",
            "name": "Kari Nordmann"
          }
        }
      ],
      "titles": [
        {
          "language": {
            "code": "SplxlOBeZQQYbYS6WxSbIA",
            "name": "Kari Nordmann"
          },
          "main": "Kristin Lavransdatter",
          "part": {
            "name": "Kari Nordmann",
            "number": "1"
          },
          "remainder": "The Wreath",
          "type": "preferred"
        }
      ],
      "works": [
        {
          "identifier": "882107",
          "relation": "contains"
        }
      ]
    },
    "renew": {
      "count": 2,
      "lastDate": "2025-03-14",
      "state": "renewable"
    }
  },
  "status": "success"
}

Schema

RenewPatronLoanResponseBody

Selected by the field status

Variant: success

RenewPatronLoanSuccess

loanPatronLoanrequired
Show 9 fieldsHide 9 fields
- acquiredFromPatronLoanAcquiredFrom
  This tells from where (the material for) this loan was acquired.
  If this field are missing, the default value local_circulation should be assumed.
  - local_circulation: Meaning that this loan was acquired from the customers own inventory.
  - interlibrary_loan: Meaning that this loan was acquired as a interlibrary loan.
  - unknown: Meaning that this information is unknown.
  See PatronLoanAcquiredFrom in the schema index
- createdTimestring (date-time)required
  The date and time the loan was made.
- dueDatestring (date)required
  The latest date on which the loan must be returned.
- idstringrequired
  This is the loan ID.
- itemIdstringrequired
  This is the item identifier of the checkout item.
- locationCheckOutOrInLocationWithoutNames
  See CheckOutOrInLocationWithoutNames in the schema index
- publicationIdstringrequired
  This is the publication ID of the loan. If this is empty, the publication is unknown.
- publicationMetadataPublicationFallback
  This metadata is only intended as fallback data, for when the provider is not able to serve the metadata through the GET /publication endpoint.
  This can for some provider be the case when working with e.g. interlibrary loans.
  See PublicationFallback in the schema index
- renewLoanRenewInforequired
  See LoanRenewInfo in the schema index
statusstringrequired
One of: success

Variant: denied

RenewPatronLoanFailure

statusstringrequired
There are many possible failure states a renewal attempt can have.
One of: denied · too_many_renewals · user_blocked · renewal_blocked_by_fees · reservation_blocked_renewal

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 username or password
  - 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 · 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.

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.