Skip to content


Repository files navigation


Copyright (C) 2018-2023 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.


Microservice to allow 3rd party discovery services to perform FOLIO patron actions via the discovery service's UI.

Additional information

The endpoint GET '/patron/account/{accountId}' has optional query parameter 'sortBy' that indicates the order of records within the lists of holds, charges, loans. The value of 'sortBy' parameter is appended as a part of a CQL query that's evaluated during separate corresponding calls to retrieve holds, charges and loans. Often, a given value of 'sortBy' will only work with one type of record (holds, loans, or charges), e.g. item.title works for holds, but not loans/charges. The expectation is that when using the 'sortBy' parameter, separate calls will be made for retrieving holds, loans, and charges. In cases where multiple 'include*' parameters are 'true' and 'sortBy' is used, it's possibile (if not probable) that some of those lists will not be sorted as desired.

Examples of requests:

  • get holds sorted by item.title field in ascending order: /patron/account/{accountId}?includeHold=true&&sortBy=item.title/sort.ascending
  • get charges sorted by title field in ascending order: /patron/account/{accountId}?includeCharges=true&&sortBy=title/sort.ascending
  • get loans sorted by loanDate field in ascending order: /patron/account/{accountId}?includeCharges=true&&sortBy=loanDate/sort.ascending

Issue tracker

See project MODPATRON at the FOLIO issue tracker.

Other documentation

Other modules are described, with further FOLIO Developer documentation at