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 "$ref": "../parameters.json#/match"
110 "$ref": "../parameters.json#/order_by"
113 "$ref": "../parameters.json#/page"
116 "$ref": "../parameters.json#/per_page"
119 "produces": ["application/json"],
122 "description": "A list of holds",
124 "$ref": "../definitions.json#/holds"
128 "description": "Authentication required",
130 "$ref": "../definitions.json#/error"
134 "description": "Hold not allowed",
136 "$ref": "../definitions.json#/error"
140 "description": "Borrower not found",
142 "$ref": "../definitions.json#/error"
146 "description": "Internal server error",
148 "$ref": "../definitions.json#/error"
152 "description": "Under maintenance",
154 "$ref": "../definitions.json#/error"
158 "x-koha-authorization": {
160 "borrowers": "edit_borrowers"
165 "x-mojo-to": "Holds#add",
166 "operationId": "addHold",
167 "tags": ["patrons", "holds"],
171 "description": "A JSON object containing informations about the new hold",
177 "description": "Internal patron identifier",
181 "description": "Internal biblio identifier",
182 "type": [ "integer", "null" ]
185 "description": "Internal item identifier",
186 "type": [ "integer", "null" ]
188 "pickup_library_id": {
189 "description": "Internal library identifier for the pickup library",
193 "description": "Hold end date",
194 "type": ["string", "null"],
198 "description": "Notes related to this hold",
199 "type": [ "string", "null" ]
202 "description": "Limit hold on one itemtype (ignored for item-level holds)",
203 "type": [ "string", "null" ]
206 "required": [ "patron_id", "pickup_library_id" ]
210 "consumes": ["application/json"],
211 "produces": ["application/json"],
214 "description": "Created hold",
216 "$ref": "../definitions.json#/hold"
220 "description": "Missing or wrong parameters",
222 "$ref": "../definitions.json#/error"
226 "description": "Authentication required",
228 "$ref": "../definitions.json#/error"
232 "description": "Hold not allowed",
234 "$ref": "../definitions.json#/error"
238 "description": "Borrower not found",
240 "$ref": "../definitions.json#/error"
244 "description": "Internal server error",
246 "$ref": "../definitions.json#/error"
250 "description": "Under maintenance",
252 "$ref": "../definitions.json#/error"
256 "x-koha-authorization": {
258 "reserveforothers": "1"
263 "/holds/{hold_id}": {
265 "x-mojo-to": "Holds#edit",
266 "operationId": "editHold",
269 "$ref": "../parameters.json#/hold_id_pp"
273 "description": "A JSON object containing fields to modify",
279 "description": "Position in waiting queue",
284 "description": "Pickup location",
288 "description": "Suspend until",
296 "consumes": ["application/json"],
297 "produces": ["application/json"],
300 "description": "Updated hold",
302 "$ref": "../definitions.json#/hold"
306 "description": "Missing or wrong parameters",
308 "$ref": "../definitions.json#/error"
312 "description": "Authentication required",
314 "$ref": "../definitions.json#/error"
318 "description": "Hold not allowed",
320 "$ref": "../definitions.json#/error"
324 "description": "Hold not found",
326 "$ref": "../definitions.json#/error"
330 "description": "Internal server error",
332 "$ref": "../definitions.json#/error"
336 "description": "Under maintenance",
338 "$ref": "../definitions.json#/error"
342 "x-koha-authorization": {
344 "reserveforothers": "1"
349 "x-mojo-to": "Holds#delete",
350 "operationId": "deleteHold",
353 "$ref": "../parameters.json#/hold_id_pp"
356 "produces": ["application/json"],
359 "description": "Hold deleted"
362 "description": "Authentication required",
364 "$ref": "../definitions.json#/error"
368 "description": "Hold not allowed",
370 "$ref": "../definitions.json#/error"
374 "description": "Hold not found",
376 "$ref": "../definitions.json#/error"
380 "description": "Internal server error",
382 "$ref": "../definitions.json#/error"
386 "description": "Under maintenance",
388 "$ref": "../definitions.json#/error"
392 "x-koha-authorization": {
394 "reserveforothers": "1"
399 "/holds/{hold_id}/priority": {
401 "x-mojo-to": "Holds#update_priority",
402 "operationId": "updateHoldPriority",
409 "$ref": "../parameters.json#/hold_id_pp"
414 "description": "An integer representing the new priority to be set for the hold",
426 "description": "The new priority value for the hold",
432 "description": "Authentication required",
434 "$ref": "../definitions.json#/error"
438 "description": "Access forbidden",
440 "$ref": "../definitions.json#/error"
444 "description": "Biblio not found",
446 "$ref": "../definitions.json#/error"
450 "description": "Unable to perform action on biblio",
452 "$ref": "../definitions.json#/error"
456 "description": "Internal error",
458 "$ref": "../definitions.json#/error"
462 "description": "Under maintenance",
464 "$ref": "../definitions.json#/error"
468 "x-koha-authorization": {
470 "reserveforothers": "modify_holds_priority"
475 "/holds/{hold_id}/suspension": {
477 "x-mojo-to": "Holds#suspend",
478 "operationId": "suspendHold",
481 "$ref": "../parameters.json#/hold_id_pp"
485 "description": "A JSON object containing fields to modify",
491 "description": "Date the hold suspension expires",
499 "consumes": ["application/json"],
500 "produces": ["application/json"],
503 "description": "Hold suspended"
506 "description": "Missing or wrong parameters",
508 "$ref": "../definitions.json#/error"
512 "description": "Authentication required",
514 "$ref": "../definitions.json#/error"
518 "description": "Hold not allowed",
520 "$ref": "../definitions.json#/error"
524 "description": "Hold not found",
526 "$ref": "../definitions.json#/error"
530 "description": "Internal server error",
532 "$ref": "../definitions.json#/error"
536 "description": "Under maintenance",
538 "$ref": "../definitions.json#/error"
542 "x-koha-authorization": {
544 "reserveforothers": "1"
549 "x-mojo-to": "Holds#resume",
550 "operationId": "resumeHold",
554 "$ref": "../parameters.json#/hold_id_pp"
557 "consumes": ["application/json"],
558 "produces": ["application/json"],
561 "description": "Hold resumed"
564 "description": "Missing or wrong parameters",
566 "$ref": "../definitions.json#/error"
570 "description": "Authentication required",
572 "$ref": "../definitions.json#/error"
576 "description": "Hold not allowed",
578 "$ref": "../definitions.json#/error"
582 "description": "Hold not found",
584 "$ref": "../definitions.json#/error"
588 "description": "Internal server error",
590 "$ref": "../definitions.json#/error"
594 "description": "Under maintenance",
596 "$ref": "../definitions.json#/error"
600 "x-koha-authorization": {
602 "reserveforothers": "1"