Hello developers, Me and Michal Denar were thinking a bit about some REST api endpoints, write down some rfcs and would like to see any comment on them ;) Thanks in advance https://wiki.koha-community.org/wiki/Checkouts_endpoint_RFC https://wiki.koha-community.org/wiki/Availability_endpoints_RFC In this one we heavily used Katrin's comments and proposed new object definition, thanks Katrin ;) https://wiki.koha-community.org/wiki/Items_endpoint_RFC -- Josef Moravec josef.moravec@gmail.com
+1 Just glacing through I saw external_id for barcode. Not sure if that is a good choice btw. I do not recognize external as meaning barcode, rfid or qr code. What about something with tag, label ? And id or code ? Checkout availability is kind of a hard term to me? Loanable ? And reservable, can_be_reserved ? Is 403 the right response for not available ? 404 or 400 ? Marcel ________________________________ Van: koha-devel-bounces@lists.koha-community.org <koha-devel-bounces@lists.koha-community.org> namens Josef Moravec <josef.moravec@gmail.com> Verzonden: dinsdag 23 oktober 2018 12:07:37 Aan: koha-devel Onderwerp: [Koha-devel] New Rest API RFCs Hello developers, Me and Michal Denar were thinking a bit about some REST api endpoints, write down some rfcs and would like to see any comment on them ;) Thanks in advance https://wiki.koha-community.org/wiki/Checkouts_endpoint_RFC https://wiki.koha-community.org/wiki/Availability_endpoints_RFC In this one we heavily used Katrin's comments and proposed new object definition, thanks Katrin ;) https://wiki.koha-community.org/wiki/Items_endpoint_RFC -- Josef Moravec josef.moravec@gmail.com<mailto:josef.moravec@gmail.com>
I'm not a big fan of items.onloan... If you want to check item availability, use the checkouts API. ...and then I realized that there's no route for items in the checkouts API. On Tue, Oct 23, 2018, 6:07 AM Josef Moravec <josef.moravec@gmail.com> wrote:
Hello developers,
Me and Michal Denar were thinking a bit about some REST api endpoints, write down some rfcs and would like to see any comment on them ;)
Thanks in advance
https://wiki.koha-community.org/wiki/Checkouts_endpoint_RFC https://wiki.koha-community.org/wiki/Availability_endpoints_RFC
In this one we heavily used Katrin's comments and proposed new object definition, thanks Katrin ;) https://wiki.koha-community.org/wiki/Items_endpoint_RFC
-- Josef Moravec josef.moravec@gmail.com
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
https://github.com/thekesolutions/koha-plugin-bibliocommons/blob/master/Koha... El mar., 23 oct. 2018 a las 10:21, Barton Chittenden (< barton@bywatersolutions.com>) escribió:
I'm not a big fan of items.onloan... If you want to check item availability, use the checkouts API.
...and then I realized that there's no route for items in the checkouts API.
On Tue, Oct 23, 2018, 6:07 AM Josef Moravec <josef.moravec@gmail.com> wrote:
Hello developers,
Me and Michal Denar were thinking a bit about some REST api endpoints, write down some rfcs and would like to see any comment on them ;)
Thanks in advance
https://wiki.koha-community.org/wiki/Checkouts_endpoint_RFC https://wiki.koha-community.org/wiki/Availability_endpoints_RFC
In this one we heavily used Katrin's comments and proposed new object definition, thanks Katrin ;) https://wiki.koha-community.org/wiki/Items_endpoint_RFC
-- Josef Moravec josef.moravec@gmail.com
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Tomás Cohen Arazi Theke Solutions (http://theke.io) ✆ +54 9351 3513384 GPG: B2F3C15F
Josef, Thanks for the taking the initiative! I added some comments about the checkouts endpoint in the wiki, but perhaps it's easier to discuss here, so I'll add them here too: While fetching the information about the checkout itself is a good start, often some more information is needed, and if it means that several requests need to be made, things get slow pretty quickly. So I'd suggest adding an expanded version of the response with at least the following extra information. This is based on my experiences with integrating several different ILS's with our VuFind based discovery interface. 1. Renewability 2. Maximum number of renewals 3. Basic information about the biblio and item (biblio.biblionumber, biblio.title, items.barcode, items.enumchron) When there are a lot of loans, supporting server-side paging and sorting can make a huge difference (especially with the expanded response). This could be accomplished with the addition of offset, limit and sort parameters. 403 is valid response code if you try to renew a non-renewable loan, but error codes should not be used to indicate a status. So the renewability check should rather return 200 and an actual response telling if renewal is possible. Regards, Ere Josef Moravec kirjoitti 23.10.2018 klo 13.07:
Hello developers,
Me and Michal Denar were thinking a bit about some REST api endpoints, write down some rfcs and would like to see any comment on them ;)
Thanks in advance
https://wiki.koha-community.org/wiki/Checkouts_endpoint_RFC https://wiki.koha-community.org/wiki/Availability_endpoints_RFC
In this one we heavily used Katrin's comments and proposed new object definition, thanks Katrin ;) https://wiki.koha-community.org/wiki/Items_endpoint_RFC
-- Josef Moravec josef.moravec@gmail.com <mailto:josef.moravec@gmail.com>
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Ere Maijala Kansalliskirjasto / The National Library of Finland
Hi Josef, I've added some new comments on the wiki for Checkouts and Items. Hope it's helpful! Katrin On 23.10.18 12:07, Josef Moravec wrote:
Hello developers,
Me and Michal Denar were thinking a bit about some REST api endpoints, write down some rfcs and would like to see any comment on them ;)
Thanks in advance
https://wiki.koha-community.org/wiki/Checkouts_endpoint_RFC https://wiki.koha-community.org/wiki/Availability_endpoints_RFC
In this one we heavily used Katrin's comments and proposed new object definition, thanks Katrin ;) https://wiki.koha-community.org/wiki/Items_endpoint_RFC
-- Josef Moravec josef.moravec@gmail.com <mailto:josef.moravec@gmail.com>
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
participants (6)
-
Barton Chittenden -
Ere Maijala -
Josef Moravec -
Katrin Fischer -
Marcel de Rooy -
Tomas Cohen Arazi