The Patron API - Reading History

To use these endpoints, the library must have the Reading History feature enabled, and the patron must have opted-in to this feature in the WebPAC. See Setting Up Reading History in the Sierra WebHelp for more information.

The Patron API contains methods for retrieving and deleting a patron's reading history. Using these endpoints, you can:

The Try it out! links below take you to the corresponding section in the interactive documentation, where you can view the model, model schema, and parameters for each available operation.

Get the Reading History for a Single Patron

To use this endpoint, your key must be assigned the Patrons Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/patrons/{id}/checkouts/history

Returns a reading history for the specified patron. Data is returned only if the patron has enabled the Reading History feature in the WebPAC. A patron's checkout ID is also returned from this endpoint.

Try it out!

Delete the Reading History for a Single Patron

DELETE /v6/patrons/{id}/checkouts/history

Deletes a patron's reading history. A patron must opt-in to Reading History feature for the deletion to work.

Try it out!

Delete Item(s) from a Patron's Reading History

DELETE /v6/patrons/{id}/checkouts/history/{checkoutHistoryId}

Deletes one or more specific items on a patron's reading history. A patron must opt-in to Reading History feature for the deletion to work.

Try it out!