# Patron Loan History Provider API v0.6.6 · 3 operations Source: https://plasapi.com/provider/v0.6.6/patron-loan-history/ No description in the specification. ## Get patron loan history `GET` `/patron/{patronId}/loan-history` · `GetPatronLoanHistory` ### Example request **cURL** ```bash curl -X GET "$PLAS_BASE_URL/patron/40218873/loan-history?version=0.6.6&before=2025-03-14T10%3A24%3A00%2B01%3A00&offset=0&size=10" \ -H 'Accept: application/json' \ -H "Authorization: Bearer $PLAS_TOKEN" ``` **JavaScript** ```javascript const response = await fetch(`${process.env.PLAS_BASE_URL}/patron/40218873/loan-history?version=0.6.6&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** ```python import os import requests response = requests.get( f"{os.environ['PLAS_BASE_URL']}/patron/40218873/loan-history", params={ "version": "0.6.6", "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() ``` The host and token are environment variables: `PLAS_BASE_URL` the provider’s base URL · `PLAS_TOKEN` an access token. ### Parameters - `patronId` (In `path`, `string`, required) — Patron ID from authentication - `before` (In `query`, `string (date-time)`, required) — This tells the time period for when we fetch data. The period will be (-∞, before]. - `offset` (In `query`, `integer`, required) — This tells the offset. The offset should be 0 or above. - `size` (In `query`, `integer`, required) — This tells the size of the request. The size should be between 1 and 50. - `sorting_type` (In `query`, `string enum`, optional) — 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` (In `query`, `string enum`, optional) — This can be used to choose if response should be sorted descending (default) or ascending. Shared across operations: `version`. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) ### Responses #### `200` Success `PatronLoanHistoryResponseBody` Example (Generated from the schema): ```json { "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" } ] } } ] } ``` #### `400` The list of errors. `Errors` Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) Example (Generated from the schema): ```json { "errors": [ { "code": 200103, "info": "200103: invalid/unsupported query parameter value" } ] } ``` #### `401` Bearer token invalid, missing, or expired. No response body. Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) #### `404` Resource not found. No response body. Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) ## Adds a loan to the patron's loan history `POST` `/patron/{patronId}/loan-history` · `AddLoanToPatronLoanHistory` ### Example request **cURL** ```bash curl -X POST "$PLAS_BASE_URL/patron/40218873/loan-history?version=0.6.6" \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $PLAS_TOKEN" \ -d '{ "acquiredFrom": { "type": "local_circulation" }, "checkinTime": "2025-03-14T10:24:00+01:00", "checkoutTime": "2025-03-14T10:24:00+01:00", "dueDate": "2025-04-11", "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" } ] } }' ``` **JavaScript** ```javascript const response = await fetch(`${process.env.PLAS_BASE_URL}/patron/40218873/loan-history?version=0.6.6`, { method: "POST", headers: { "Accept": "application/json", "Content-Type": "application/json", "Authorization": `Bearer ${process.env.PLAS_TOKEN}`, }, body: JSON.stringify({ "acquiredFrom": { "type": "local_circulation" }, "checkinTime": "2025-03-14T10:24:00+01:00", "checkoutTime": "2025-03-14T10:24:00+01:00", "dueDate": "2025-04-11", "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" } ] } }), }); ``` **Python** ```python import os import requests response = requests.post( f"{os.environ['PLAS_BASE_URL']}/patron/40218873/loan-history", params={ "version": "0.6.6", }, headers={ "Accept": "application/json", "Content-Type": "application/json", "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}", }, json={ "acquiredFrom": { "type": "local_circulation", }, "checkinTime": "2025-03-14T10:24:00+01:00", "checkoutTime": "2025-03-14T10:24:00+01:00", "dueDate": "2025-04-11", "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", }, ], }, }, ) response.raise_for_status() ``` The host and token are environment variables: `PLAS_BASE_URL` the provider’s base URL · `PLAS_TOKEN` an access token. ### Parameters - `patronId` (In `path`, `string`, required) — Patron ID from authentication Shared across operations: `version`. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) ### Request body `application/json` · required [`AddLoanToPatronLoanHistoryRequestBody`](https://plasapi.com/provider/v0.6.6/schemas/#AddLoanToPatronLoanHistoryRequestBody) ### Responses #### `204` Success No response body. #### `400` The list of errors. `Errors` Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) Example (Generated from the schema): ```json { "errors": [ { "code": 200103, "info": "200103: invalid/unsupported query parameter value" } ] } ``` #### `401` Bearer token invalid, missing, or expired. No response body. Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) #### `404` Resource not found. No response body. Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) ## Delete loan from patron loan history `DELETE` `/patron/{patronId}/loan-history/{loanHistoryId}` · `DeleteLoanFromPatronLoanHistory` ### Example request **cURL** ```bash curl -X DELETE "$PLAS_BASE_URL/patron/40218873/loan-history/71150392?version=0.6.6" \ -H 'Accept: application/json' \ -H "Authorization: Bearer $PLAS_TOKEN" ``` **JavaScript** ```javascript const response = await fetch(`${process.env.PLAS_BASE_URL}/patron/40218873/loan-history/71150392?version=0.6.6`, { method: "DELETE", headers: { "Accept": "application/json", "Authorization": `Bearer ${process.env.PLAS_TOKEN}`, }, }); ``` **Python** ```python import os import requests response = requests.delete( f"{os.environ['PLAS_BASE_URL']}/patron/40218873/loan-history/71150392", params={ "version": "0.6.6", }, headers={ "Accept": "application/json", "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}", }, ) response.raise_for_status() ``` The host and token are environment variables: `PLAS_BASE_URL` the provider’s base URL · `PLAS_TOKEN` an access token. ### Parameters - `patronId` (In `path`, `string`, required) — Patron ID from authentication - `loanHistoryId` (In `path`, `string`, required) — Loan history ID Shared across operations: `version`. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) ### Responses #### `204` Success No response body. #### `400` The list of errors. `Errors` Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) Example (Generated from the schema): ```json { "errors": [ { "code": 200103, "info": "200103: invalid/unsupported query parameter value" } ] } ``` #### `401` Bearer token invalid, missing, or expired. No response body. Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/) #### `404` Resource not found. No response body. Shared response, defined once for the whole API. [See the shared contract on the version page.](https://plasapi.com/provider/v0.6.6/)