12 description: Internal hold identifier
16 description: Internal patron identifier
25 description: Internal biblio identifier
29 description: Internal item group identifier
31 - name: pickup_library_id
33 description: Internal library identifier for the pickup library
35 - name: cancellation_date
37 description: The date the hold was cancelled
42 description: Notes related to this hold
46 description: Where in the queue the patron sits
50 description: Found status
54 description: Time of latest update
58 description: Internal item identifier
62 description: Date the item was marked as waiting for the patron
64 - name: expiration_date
66 description: Date the hold expires
68 - name: lowest_priority
70 description: Lowest priority
74 description: Suspended
76 - name: suspended_until
78 description: Suspended until
82 description: Non priority hold
84 - $ref: "../swagger.yaml#/parameters/match"
85 - $ref: "../swagger.yaml#/parameters/order_by"
86 - $ref: "../swagger.yaml#/parameters/page"
87 - $ref: "../swagger.yaml#/parameters/per_page"
88 - $ref: "../swagger.yaml#/parameters/q_param"
89 - $ref: "../swagger.yaml#/parameters/q_body"
90 - $ref: "../swagger.yaml#/parameters/q_header"
91 - $ref: "../swagger.yaml#/parameters/request_id_header"
96 description: A list of holds
98 $ref: "../swagger.yaml#/definitions/holds"
100 description: Authentication required
102 $ref: "../swagger.yaml#/definitions/error"
104 description: Hold not allowed
106 $ref: "../swagger.yaml#/definitions/error"
108 description: Borrower not found
110 $ref: "../swagger.yaml#/definitions/error"
113 Internal server error. Possible `error_code` attribute values:
115 * `internal_server_error`
117 $ref: "../swagger.yaml#/definitions/error"
119 description: Under maintenance
121 $ref: "../swagger.yaml#/definitions/error"
122 x-koha-authorization:
124 reserveforothers: place_holds
134 description: A JSON object containing informations about the new hold
140 description: Internal patron identifier
143 description: Internal biblio identifier
148 description: Internal item group identifier
153 description: The date the hold was placed
159 description: Internal item identifier
164 description: Internal library identifier for the pickup library
167 description: Hold end date
173 description: Notes related to this hold
178 description: Limit hold on one itemtype (ignored for item-level holds)
183 description: Set this hold as non priority
190 additionalProperties: false
191 - name: x-koha-override
194 description: Overrides list sent as a request header
200 collectionFormat: csv
207 description: Created hold
209 $ref: "../swagger.yaml#/definitions/hold"
211 description: Missing or wrong parameters
213 $ref: "../swagger.yaml#/definitions/error"
215 description: Authentication required
217 $ref: "../swagger.yaml#/definitions/error"
219 description: Hold not allowed
221 $ref: "../swagger.yaml#/definitions/error"
223 description: Borrower not found
225 $ref: "../swagger.yaml#/definitions/error"
228 Internal server error. Possible `error_code` attribute values:
230 * `internal_server_error`
232 $ref: "../swagger.yaml#/definitions/error"
234 description: Under maintenance
236 $ref: "../swagger.yaml#/definitions/error"
237 x-koha-authorization:
239 reserveforothers: "1"
242 x-mojo-to: Holds#edit
243 operationId: editHold
248 - $ref: "../swagger.yaml#/parameters/hold_id_pp"
251 description: A JSON object containing fields to modify
257 description: Position in waiting queue
261 description: Internal library identifier for the pickup library
264 description: Date until which the hold has been suspended
267 additionalProperties: false
274 description: Updated hold
276 $ref: "../swagger.yaml#/definitions/hold"
278 description: Missing or wrong parameters
280 $ref: "../swagger.yaml#/definitions/error"
282 description: Authentication required
284 $ref: "../swagger.yaml#/definitions/error"
286 description: Hold not allowed
288 $ref: "../swagger.yaml#/definitions/error"
290 description: Hold not found
292 $ref: "../swagger.yaml#/definitions/error"
295 Internal server error. Possible `error_code` attribute values:
297 * `internal_server_error`
299 $ref: "../swagger.yaml#/definitions/error"
301 description: Under maintenance
303 $ref: "../swagger.yaml#/definitions/error"
304 x-koha-authorization:
306 reserveforothers: "1"
308 x-mojo-to: Holds#edit
309 operationId: overwriteHold
313 description: This route is being deprecated and will be removed in future releases.
314 Please migrate your project to use PATCH /holds/{hold_id} instead.
316 - $ref: "../swagger.yaml#/parameters/hold_id_pp"
319 description: A JSON object containing fields to modify
325 description: Position in waiting queue
329 description: Internal library identifier for the pickup library
332 description: Date until which the hold has been suspended
335 additionalProperties: false
342 description: Updated hold
344 $ref: "../swagger.yaml#/definitions/hold"
346 description: Missing or wrong parameters
348 $ref: "../swagger.yaml#/definitions/error"
350 description: Authentication required
352 $ref: "../swagger.yaml#/definitions/error"
354 description: Hold not allowed
356 $ref: "../swagger.yaml#/definitions/error"
358 description: Hold not found
360 $ref: "../swagger.yaml#/definitions/error"
363 Internal server error. Possible `error_code` attribute values:
365 * `internal_server_error`
367 $ref: "../swagger.yaml#/definitions/error"
369 description: Under maintenance
371 $ref: "../swagger.yaml#/definitions/error"
372 x-koha-authorization:
374 reserveforothers: "1"
376 x-mojo-to: Holds#delete
377 operationId: deleteHold
382 - $ref: "../swagger.yaml#/parameters/hold_id_pp"
383 - name: x-koha-override
386 description: Overrides list sent as a request header
391 - cancellation-request-flow
392 collectionFormat: csv
397 description: Hold request recorded
399 description: Hold deleted
401 description: Authentication required
403 $ref: "../swagger.yaml#/definitions/error"
405 description: Hold not allowed
407 $ref: "../swagger.yaml#/definitions/error"
409 description: Hold not found
411 $ref: "../swagger.yaml#/definitions/error"
414 Internal server error. Possible `error_code` attribute values:
416 * `internal_server_error`
418 $ref: "../swagger.yaml#/definitions/error"
420 description: Under maintenance
422 $ref: "../swagger.yaml#/definitions/error"
423 x-koha-authorization:
425 reserveforothers: place_holds
426 "/holds/{hold_id}/priority":
428 x-mojo-to: Holds#update_priority
429 operationId: updateHoldPriority
432 summary: Update priority for the hold
434 - $ref: "../swagger.yaml#/parameters/hold_id_pp"
437 description: An integer representing the new priority to be set for the hold
445 description: The new priority value for the hold
449 description: Authentication required
451 $ref: "../swagger.yaml#/definitions/error"
453 description: Access forbidden
455 $ref: "../swagger.yaml#/definitions/error"
457 description: Biblio not found
459 $ref: "../swagger.yaml#/definitions/error"
461 description: Unable to perform action on biblio
463 $ref: "../swagger.yaml#/definitions/error"
466 Internal server error. Possible `error_code` attribute values:
468 * `internal_server_error`
470 $ref: "../swagger.yaml#/definitions/error"
472 description: Under maintenance
474 $ref: "../swagger.yaml#/definitions/error"
475 x-koha-authorization:
477 reserveforothers: modify_holds_priority
478 "/holds/{hold_id}/suspension":
480 x-mojo-to: Holds#suspend
481 operationId: suspendHold
484 summary: Suspend the hold
486 - $ref: "../swagger.yaml#/parameters/hold_id_pp"
489 description: A JSON object containing fields to modify
495 description: Date the hold suspension expires
498 additionalProperties: false
505 description: Hold suspended
507 description: Missing or wrong parameters
509 $ref: "../swagger.yaml#/definitions/error"
511 description: Authentication required
513 $ref: "../swagger.yaml#/definitions/error"
515 description: Hold not allowed
517 $ref: "../swagger.yaml#/definitions/error"
519 description: Hold not found
521 $ref: "../swagger.yaml#/definitions/error"
524 Internal server error. Possible `error_code` attribute values:
526 * `internal_server_error`
528 $ref: "../swagger.yaml#/definitions/error"
530 description: Under maintenance
532 $ref: "../swagger.yaml#/definitions/error"
533 x-koha-authorization:
535 reserveforothers: place_holds
537 x-mojo-to: Holds#resume
538 operationId: resumeHold
543 - $ref: "../swagger.yaml#/parameters/hold_id_pp"
550 description: Hold resumed
552 description: Missing or wrong parameters
554 $ref: "../swagger.yaml#/definitions/error"
556 description: Authentication required
558 $ref: "../swagger.yaml#/definitions/error"
560 description: Hold not allowed
562 $ref: "../swagger.yaml#/definitions/error"
564 description: Hold not found
566 $ref: "../swagger.yaml#/definitions/error"
569 Internal server error. Possible `error_code` attribute values:
571 * `internal_server_error`
573 $ref: "../swagger.yaml#/definitions/error"
575 description: Under maintenance
577 $ref: "../swagger.yaml#/definitions/error"
578 x-koha-authorization:
580 reserveforothers: place_holds
581 "/holds/{hold_id}/pickup_locations":
583 x-mojo-to: Holds#pickup_locations
584 operationId: getHoldPickupLocations
587 summary: Get valid pickup locations for hold
589 - name: x-koha-override
592 description: Overrides list sent as a request header
598 collectionFormat: csv
599 - $ref: "../swagger.yaml#/parameters/hold_id_pp"
600 - $ref: "../swagger.yaml#/parameters/match"
601 - $ref: "../swagger.yaml#/parameters/order_by"
602 - $ref: "../swagger.yaml#/parameters/page"
603 - $ref: "../swagger.yaml#/parameters/per_page"
604 - $ref: "../swagger.yaml#/parameters/q_param"
605 - $ref: "../swagger.yaml#/parameters/q_body"
606 - $ref: "../swagger.yaml#/parameters/q_header"
607 - $ref: "../swagger.yaml#/parameters/request_id_header"
612 description: Hold pickup location
616 $ref: "../swagger.yaml#/definitions/library"
618 description: Missing or wrong parameters
620 $ref: "../swagger.yaml#/definitions/error"
622 description: Authentication required
624 $ref: "../swagger.yaml#/definitions/error"
626 description: Hold pickup location list not allowed
628 $ref: "../swagger.yaml#/definitions/error"
630 description: Hold not found
632 $ref: "../swagger.yaml#/definitions/error"
635 Internal server error. Possible `error_code` attribute values:
637 * `internal_server_error`
639 $ref: "../swagger.yaml#/definitions/error"
641 description: Under maintenance
643 $ref: "../swagger.yaml#/definitions/error"
644 x-koha-authorization:
646 reserveforothers: place_holds
647 "/holds/{hold_id}/pickup_location":
649 x-mojo-to: Holds#update_pickup_location
650 operationId: updateHoldPickupLocation
653 summary: Update pickup location for the hold
654 description: Set a new pickup location for the hold
656 - $ref: "../swagger.yaml#/parameters/hold_id_pp"
659 description: Pickup location
666 description: Internal identifier for the pickup library
667 additionalProperties: false
672 description: The new pickup location value for the hold
678 description: Internal identifier for the pickup library
679 additionalProperties: false
681 description: Missing or wrong parameters
683 $ref: "../swagger.yaml#/definitions/error"
685 description: Authentication required
687 $ref: "../swagger.yaml#/definitions/error"
689 description: Access forbidden
691 $ref: "../swagger.yaml#/definitions/error"
693 description: Hold not found
695 $ref: "../swagger.yaml#/definitions/error"
698 Unable to perform action on hold. Possible `error_code` attribute values:
702 * `hold_in_processing`
704 $ref: "../swagger.yaml#/definitions/error"
707 Internal server error. Possible `error_code` attribute values:
709 * `internal_server_error`
711 description: Under maintenance
713 $ref: "../swagger.yaml#/definitions/error"
714 x-koha-authorization:
716 reserveforothers: place_holds