Availability endpoints RFC
Jump to navigation
Jump to search
Relevant bugs
13927: Add API route to check hold capabilities (https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13927)
16825: Add API route for getting an item (https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=16825)
16826: REST API: Add API routes for getting item availability and holdability (https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=16826)
Actions and routes
Description | Action | Proposed path |
Get checkout availibility for an object | GET |
/<object>/{object_id}/allows_checkout |
Get hold availibility for an object | GET |
/<object>/{object_id}/allows_hold |
Get availibility for an object | GET |
/<object>/{object_id}/allows_all |
Where <object> could be:
- biblios
- items
Query params
- patron_id - finds availability for a patron
- library_id - limits results by library
without any param it return general/anonymous availability in all libraries
Response
200 and object describing avaiability