/patron/{patronId}/reservation Get patron reservations
Example request
cURL
curl -X GET "$PLAS_BASE_URL/patron/40218873/reservation?version=0.6.3" \
-H 'Accept: application/json' \
-H "Authorization: Bearer $PLAS_TOKEN"JavaScript
const response = await fetch(`${process.env.PLAS_BASE_URL}/patron/40218873/reservation?version=0.6.3`, {
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/reservation",
params={
"version": "0.6.3",
},
headers={
"Accept": "application/json",
"Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
},
)
data = response.json()PLAS_BASE_URL the provider’s base URL · PLAS_TOKEN an access token.
Parameters
- patronIdrequired
- path · stringExample: 40218873
Patron ID from authentication
Responses
200 Success PatronReservationResponseBody
Example
{
"reservations": [
{
"createdTime": "2025-03-14T10:24:00+01:00",
"expirationDate": "2025-03-14",
"fulfillmentBy": {
"type": "local_circulation"
},
"id": "94549",
"itemId": "03011042557129",
"pickup": {
"expirationDate": "2025-03-14",
"location": {
"branchId": "nordby-main",
"branchName": "Nordby Main Library",
"sections": [
{
"id": "nordby-main-children",
"name": "Children’s department",
"type": "department"
}
]
},
"note": "Shelf 9"
},
"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"
}
]
},
"queueNumber": 1,
"state": "ready_for_pickup"
}
]
}Schema
Show 10 fieldsHide 10 fields
- createdTimestring (date-time)required
The date and time the reservation was created.
- expirationDatestring (date)
The date when the reservation expires. If this is missing, the value is unknown.
- fulfillmentByPatronReservationFulfillmentBy
This tells from where the material that are expected to fulfill this reservation will be acquired from. If this field are missing, the default value local_circulation should be assumed.
- local_circulation: (default) Meaning that this reservation will be fulfilling from the customers own inventory.
- interlibrary_loan: Meaning that this reservation will be fulfilled as a interlibrary loan.
- purchase: Meaning that reservation can not be fulfilled right away, but a request to purchase the material has been submitted.
- unknown: Meaning that this information is unknown.
Show 4 variantsHide 4 variants
Selected by the field type
Variant: local_circulation
PatronReservationFulfillmentByTypeLocalCirculation
See PatronReservationFulfillmentByTypeLocalCirculation in the schema index
Variant: interlibrary_loan
PatronReservationFulfillmentByTypeInterlibraryLoan
See PatronReservationFulfillmentByTypeInterlibraryLoan in the schema index
- idstringrequired
This is the reservation ID.
- itemIdstring
This is the item identifier that actually fulfills the reservation. This can often only be set when the reservation is ready for pickup. If the reservation is on item level, it can be set earlier.
- pickupobjectrequired
Show 3 fieldsHide 3 fields
- expirationDatestring (date)
The date for the last chance to pick up the reservation. If this is missing, the value is unknown.
- notestring
This is the note that is used to tell the patron where to get the reservation.
E.g.- a shelf number, e.g. "Shelf 9".
- an instruction, e.g. "Front desk"
- an identifier, e.g. "10/114"
- publicationIdstringrequired
This is the publication ID of the reservation. 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, ...
- 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.
- identifierstringrequired
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.
- queueNumberinteger
The queue number tells what number in the queue the patron is. If this is missing, it represents that the queue number is unknown.
- statestringrequired
This represents where in the acquiring process this reservation is.
One of: ready_for_pickup · in_queue · postponed
400 The list of errors. Errors
Shared response, defined once for the whole API. See the shared contract on the version page.
Example
{
"errors": [
{
"code": 200103,
"info": "200103: invalid/unsupported query parameter value"
}
]
}Schema
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.
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.