4 "x-mojo-to": "Holds#list",
5 "operationId": "listHolds",
6 "tags": ["patrons", "holds"],
11 "description": "Internal reserve identifier",
17 "description": "Internal patron identifier",
23 "description": "Hold",
30 "description": "Internal biblio identifier",
34 "name": "pickup_library_id",
36 "description": "Internal library identifier for the pickup library",
40 "name": "cancellation_date",
42 "description": "The date the hold was cancelled",
49 "description": "Notes related to this hold",
55 "description": "Where in the queue the patron sits",
61 "description": "Found status",
67 "description": "Time of latest update",
73 "description": "Internal item identifier",
77 "name": "waiting_date",
79 "description": "Date the item was marked as waiting for the patron",
83 "name": "expiration_date",
85 "description": "Date the hold expires",
89 "name": "lowest_priority",
91 "description": "Lowest priority",
97 "description": "Suspended",
101 "name": "suspended_until",
103 "description": "Suspended until",
107 "name": "non_priority",
109 "description": "Non priority hold",
113 "$ref": "../parameters.json#/match"
116 "$ref": "../parameters.json#/order_by"
119 "$ref": "../parameters.json#/page"
122 "$ref": "../parameters.json#/per_page"
125 "produces": ["application/json"],
128 "description": "A list of holds",
130 "$ref": "../definitions.json#/holds"
134 "description": "Authentication required",
136 "$ref": "../definitions.json#/error"
140 "description": "Hold not allowed",
142 "$ref": "../definitions.json#/error"
146 "description": "Borrower not found",
148 "$ref": "../definitions.json#/error"
152 "description": "Internal server error",
154 "$ref": "../definitions.json#/error"
158 "description": "Under maintenance",
160 "$ref": "../definitions.json#/error"
164 "x-koha-authorization": {
166 "borrowers": "edit_borrowers"
171 "x-mojo-to": "Holds#add",
172 "operationId": "addHold",
173 "tags": ["patrons", "holds"],
177 "description": "A JSON object containing informations about the new hold",
183 "description": "Internal patron identifier",
187 "description": "Internal biblio identifier",
188 "type": [ "integer", "null" ]
191 "description": "Internal item identifier",
192 "type": [ "integer", "null" ]
194 "pickup_library_id": {
195 "description": "Internal library identifier for the pickup library",
199 "description": "Hold end date",
200 "type": ["string", "null"],
204 "description": "Notes related to this hold",
205 "type": [ "string", "null" ]
208 "description": "Limit hold on one itemtype (ignored for item-level holds)",
209 "type": [ "string", "null" ]
212 "description": "Set this hold as non priority",
213 "type": [ "boolean", "null" ]
216 "required": [ "patron_id", "pickup_library_id" ]
220 "consumes": ["application/json"],
221 "produces": ["application/json"],
224 "description": "Created hold",
226 "$ref": "../definitions.json#/hold"
230 "description": "Missing or wrong parameters",
232 "$ref": "../definitions.json#/error"
236 "description": "Authentication required",
238 "$ref": "../definitions.json#/error"
242 "description": "Hold not allowed",
244 "$ref": "../definitions.json#/error"
248 "description": "Borrower not found",
250 "$ref": "../definitions.json#/error"
254 "description": "Internal server error",
256 "$ref": "../definitions.json#/error"
260 "description": "Under maintenance",
262 "$ref": "../definitions.json#/error"
266 "x-koha-authorization": {
268 "reserveforothers": "1"
272 "AllowHoldPolicyOverride": 1
276 "/holds/{hold_id}": {
278 "x-mojo-to": "Holds#edit",
279 "operationId": "editHold",
282 "$ref": "../parameters.json#/hold_id_pp"
286 "description": "A JSON object containing fields to modify",
292 "description": "Position in waiting queue",
297 "description": "Pickup location",
301 "description": "Suspend until",
309 "consumes": ["application/json"],
310 "produces": ["application/json"],
313 "description": "Updated hold",
315 "$ref": "../definitions.json#/hold"
319 "description": "Missing or wrong parameters",
321 "$ref": "../definitions.json#/error"
325 "description": "Authentication required",
327 "$ref": "../definitions.json#/error"
331 "description": "Hold not allowed",
333 "$ref": "../definitions.json#/error"
337 "description": "Hold not found",
339 "$ref": "../definitions.json#/error"
343 "description": "Internal server error",
345 "$ref": "../definitions.json#/error"
349 "description": "Under maintenance",
351 "$ref": "../definitions.json#/error"
355 "x-koha-authorization": {
357 "reserveforothers": "1"
362 "x-mojo-to": "Holds#delete",
363 "operationId": "deleteHold",
366 "$ref": "../parameters.json#/hold_id_pp"
369 "produces": ["application/json"],
372 "description": "Hold deleted"
375 "description": "Authentication required",
377 "$ref": "../definitions.json#/error"
381 "description": "Hold not allowed",
383 "$ref": "../definitions.json#/error"
387 "description": "Hold not found",
389 "$ref": "../definitions.json#/error"
393 "description": "Internal server error",
395 "$ref": "../definitions.json#/error"
399 "description": "Under maintenance",
401 "$ref": "../definitions.json#/error"
405 "x-koha-authorization": {
407 "reserveforothers": "1"
412 "/holds/{hold_id}/priority": {
414 "x-mojo-to": "Holds#update_priority",
415 "operationId": "updateHoldPriority",
422 "$ref": "../parameters.json#/hold_id_pp"
427 "description": "An integer representing the new priority to be set for the hold",
439 "description": "The new priority value for the hold",
445 "description": "Authentication required",
447 "$ref": "../definitions.json#/error"
451 "description": "Access forbidden",
453 "$ref": "../definitions.json#/error"
457 "description": "Biblio not found",
459 "$ref": "../definitions.json#/error"
463 "description": "Unable to perform action on biblio",
465 "$ref": "../definitions.json#/error"
469 "description": "Internal error",
471 "$ref": "../definitions.json#/error"
475 "description": "Under maintenance",
477 "$ref": "../definitions.json#/error"
481 "x-koha-authorization": {
483 "reserveforothers": "modify_holds_priority"
488 "/holds/{hold_id}/suspension": {
490 "x-mojo-to": "Holds#suspend",
491 "operationId": "suspendHold",
494 "$ref": "../parameters.json#/hold_id_pp"
498 "description": "A JSON object containing fields to modify",
504 "description": "Date the hold suspension expires",
512 "consumes": ["application/json"],
513 "produces": ["application/json"],
516 "description": "Hold suspended"
519 "description": "Missing or wrong parameters",
521 "$ref": "../definitions.json#/error"
525 "description": "Authentication required",
527 "$ref": "../definitions.json#/error"
531 "description": "Hold not allowed",
533 "$ref": "../definitions.json#/error"
537 "description": "Hold not found",
539 "$ref": "../definitions.json#/error"
543 "description": "Internal server error",
545 "$ref": "../definitions.json#/error"
549 "description": "Under maintenance",
551 "$ref": "../definitions.json#/error"
555 "x-koha-authorization": {
557 "reserveforothers": "1"
562 "x-mojo-to": "Holds#resume",
563 "operationId": "resumeHold",
567 "$ref": "../parameters.json#/hold_id_pp"
570 "consumes": ["application/json"],
571 "produces": ["application/json"],
574 "description": "Hold resumed"
577 "description": "Missing or wrong parameters",
579 "$ref": "../definitions.json#/error"
583 "description": "Authentication required",
585 "$ref": "../definitions.json#/error"
589 "description": "Hold not allowed",
591 "$ref": "../definitions.json#/error"
595 "description": "Hold not found",
597 "$ref": "../definitions.json#/error"
601 "description": "Internal server error",
603 "$ref": "../definitions.json#/error"
607 "description": "Under maintenance",
609 "$ref": "../definitions.json#/error"
613 "x-koha-authorization": {
615 "reserveforothers": "1"
620 "/holds/{hold_id}/pickup_locations": {
622 "x-mojo-to": "Holds#pickup_locations",
623 "operationId": "getHoldPickupLocations",
627 "$ref": "../parameters.json#/hold_id_pp"
630 "$ref": "../parameters.json#/match"
633 "$ref": "../parameters.json#/order_by"
636 "$ref": "../parameters.json#/page"
639 "$ref": "../parameters.json#/per_page"
642 "$ref": "../parameters.json#/q_param"
645 "$ref": "../parameters.json#/q_body"
648 "$ref": "../parameters.json#/q_header"
651 "produces": ["application/json"],
654 "description": "Hold pickup location",
658 "$ref": "../definitions.json#/library"
663 "description": "Missing or wrong parameters",
665 "$ref": "../definitions.json#/error"
669 "description": "Authentication required",
671 "$ref": "../definitions.json#/error"
675 "description": "Hold pickup location list not allowed",
677 "$ref": "../definitions.json#/error"
681 "description": "Hold not found",
683 "$ref": "../definitions.json#/error"
687 "description": "Internal server error",
689 "$ref": "../definitions.json#/error"
693 "description": "Under maintenance",
695 "$ref": "../definitions.json#/error"
699 "x-koha-authorization": {
701 "reserveforothers": "place_holds"
706 "/holds/{hold_id}/pickup_location": {
708 "x-mojo-to": "Holds#update_pickup_location",
709 "operationId": "updateHoldPickupLocation",
713 "$ref": "../parameters.json#/hold_id_pp"
718 "description": "Pickup location",
723 "pickup_library_id": {
725 "description": "Internal identifier for the pickup library"
736 "description": "The new pickup location value for the hold",
740 "pickup_library_id": {
742 "description": "Internal identifier for the pickup library"
748 "description": "Missing or wrong parameters",
750 "$ref": "../definitions.json#/error"
754 "description": "Authentication required",
756 "$ref": "../definitions.json#/error"
760 "description": "Access forbidden",
762 "$ref": "../definitions.json#/error"
766 "description": "Hold not found",
768 "$ref": "../definitions.json#/error"
772 "description": "Unable to perform action on hold",
774 "$ref": "../definitions.json#/error"
778 "description": "Internal error",
780 "$ref": "../definitions.json#/error"
784 "description": "Under maintenance",
786 "$ref": "../definitions.json#/error"
790 "x-koha-authorization": {
792 "reserveforothers": "place_holds"