Holds suspension endpoint RFC

From Koha Wiki
Jump to navigation Jump to search

This RFC proposes a way to suspend a hold, and resume a suspended hold. This is implemented on bug 22206

Actions and routes

The following table presents proposed implementation.

Description Action Proposed
Suspend a hold
 POST
 /holds/{hold_id}/suspension
Resume a suspended hold
 DELETE
 /holds/{hold_id}/suspension

Request body

This only applies to the POST action. It is not mandatory (hold will stay suspended indefinitely).

Attributes Description
end_date The date the hold suspension expires

Discussion

We already have an expiration_date on holds with a different meaning (when the hold is no longer needed/last pick-up date). I think it could avoid confusion to use a different naming here. Maybe suspension_date? --Kfischer 02:01, 25 January 2019 (EST)

I disagree here.. we have the context within the route /suspension and suspention_date could mean either start or end of the suspension period... I'd stick with expiration_date for consistency and have it contextual by route MRenvoize 09:57, 13 February 2019 (EST)