/patron/{patronId}/loan-history Get patron loan history
Eksempel på kald
cURL
curl -X GET "$PLAS_BASE_URL/patron/40218873/loan-history?version=0.6.3&before=2025-03-14T10%3A24%3A00%2B01%3A00&offset=0&size=10" \
-H 'Accept: application/json' \
-H "Authorization: Bearer $PLAS_TOKEN"JavaScript
const response = await fetch(`${process.env.PLAS_BASE_URL}/patron/40218873/loan-history?version=0.6.3&before=2025-03-14T10%3A24%3A00%2B01%3A00&offset=0&size=10`, {
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-history",
params={
"version": "0.6.3",
"before": "2025-03-14T10:24:00+01:00",
"offset": "0",
"size": "10",
},
headers={
"Accept": "application/json",
"Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
},
)
data = response.json()PLAS_BASE_URL providerens adresse · PLAS_TOKEN et access token.
Parametre
- patronIdpåkrævet
- path · stringEksempel: 40218873
Patron ID from authentication
- beforepåkrævet
- query · string (date-time)Eksempel: 2025-03-14T10:24:00+01:00
This tells the time period for when we fetch data. The period will be (-∞, before].
- offsetpåkrævet
- query · integerEksempel: 0
This tells the offset. The offset should be 0 or above.
- sizepåkrævet
- query · integerEksempel: 10
This tells the size of the request. The size should be between 1 and 50.
- sorting_type
- query · stringEksempel: addedToHistoryTime
This can be used to choose the value (default: addedToHistoryTime) that the response is sorted on.
When sorting, some entries might not have the chosen sorting type (or it may be null). When this happens, the entries should be sorted last when sorting order is
desc, and then be sorted on addedToHistoryTime. - sorting
- query · stringEksempel: desc
This can be used to choose if response should be sorted descending (default) or ascending.
Svar
200 Success PatronLoanHistoryResponseBody
Eksempel
{
"loanHistory": [
{
"acquiredFrom": {
"type": "local_circulation"
},
"addedToHistoryTime": "2025-03-14T10:24:00+01:00",
"checkinTime": "2025-03-14T10:24:00+01:00",
"checkoutTime": "2025-03-14T10:24:00+01:00",
"dueDate": "2025-04-11",
"id": "94549",
"itemId": "03011042557129",
"loanId": "58210447",
"manuallyAdded": false,
"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"
}
]
}
}
]
}Skema
Vis 11 felterSkjul 11 felter
- 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.
Vis 3 varianterSkjul 3 varianter
Vælges af feltet type
Variant: local_circulation
PatronLoanAcquiredFromTypeLocalCirculation
Se PatronLoanAcquiredFromTypeLocalCirculation i skema-indekset
Variant: interlibrary_loan
PatronLoanAcquiredFromTypeInterlibraryLoan
Se PatronLoanAcquiredFromTypeInterlibraryLoan i skema-indekset
- addedToHistoryTimestring (date-time)påkrævet
The date and time when the loan was added to the patron loan history.
- checkinTimestring (date-time)
The date and time the loan was checkin.
- checkoutTimestring (date-time)
The date and time the loan was made.
- dueDatestring (date)
The due date of the loan at the time of checkin.
- idstringpåkrævet
This is the loan history ID (not the loan ID).
- itemIdstring
This is the item identifier of the checkout item.
- loanIdstring
This is the loan ID.
- manuallyAddedbooleanpåkrævet
Was the loan added manually by the patron.
- publicationIdstringpåkrævet
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.
Vis 14 felterSkjul 14 felter
- additionalIdentifiersarray of AdditionalIdentifier
Other identifiers, like: ISBN, ISSN, ...
- bindingBinding
- contributorsarray of Contributor
The contributor(s) to the publication.
- creatorsarray of Contributor
The creator(s) of the publication.
- editionEdition
- extentarray of Extent
Together all the Extents in the array describes the total extent of the publication.
- identifierstringpåkrævet
Publication identifier. This is searchable through the GET /publication endpoint.
Images to use with the publication.
- languagearray of Language
This is the language(s) of the this publication. If the publication uses multi languages this will also contain them.
- mediaTypesarray of MediaType
- publicationDateDate
Date of publication.
- publishersarray of PublisherAndPlaces
List of publishers and associated place(s) of publication.
Title of the publication.
400 The list of errors. Errors
Fælles svar, defineret én gang for hele API’et. Se den fælles kontrakt på versionssiden.
Eksempel
{
"errors": [
{
"code": 200103,
"info": "200103: invalid/unsupported query parameter value"
}
]
}Skema
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.