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": "cancelation_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": "Successful deletion",
365 "description": "Authentication required",
367 "$ref": "../definitions.json#/error"
371 "description": "Hold not allowed",
373 "$ref": "../definitions.json#/error"
377 "description": "Hold not found",
379 "$ref": "../definitions.json#/error"
383 "description": "Internal server error",
385 "$ref": "../definitions.json#/error"
389 "description": "Under maintenance",
391 "$ref": "../definitions.json#/error"
395 "x-koha-authorization": {
397 "reserveforothers": "1"
402 "/holds/{hold_id}/priority": {
404 "x-mojo-to": "Holds#update_priority",
405 "operationId": "updateHoldPriority",
412 "$ref": "../parameters.json#/hold_id_pp"
417 "description": "An integer representing the new priority to be set for the hold",
429 "description": "The new priority value for the hold",
435 "description": "Authentication required",
437 "$ref": "../definitions.json#/error"
441 "description": "Access forbidden",
443 "$ref": "../definitions.json#/error"
447 "description": "Biblio not found",
449 "$ref": "../definitions.json#/error"
453 "description": "Unable to perform action on biblio",
455 "$ref": "../definitions.json#/error"
459 "description": "Internal error",
461 "$ref": "../definitions.json#/error"
465 "description": "Under maintenance",
467 "$ref": "../definitions.json#/error"
471 "x-koha-authorization": {
473 "reserveforothers": "modify_holds_priority"
478 "/holds/{hold_id}/suspension": {
480 "x-mojo-to": "Holds#suspend",
481 "operationId": "suspendHold",
484 "$ref": "../parameters.json#/hold_id_pp"
488 "description": "A JSON object containing fields to modify",
494 "description": "Date the hold suspension expires",
502 "consumes": ["application/json"],
503 "produces": ["application/json"],
506 "description": "Hold suspended"
509 "description": "Missing or wrong parameters",
511 "$ref": "../definitions.json#/error"
515 "description": "Authentication required",
517 "$ref": "../definitions.json#/error"
521 "description": "Hold not allowed",
523 "$ref": "../definitions.json#/error"
527 "description": "Hold not found",
529 "$ref": "../definitions.json#/error"
533 "description": "Internal server error",
535 "$ref": "../definitions.json#/error"
539 "description": "Under maintenance",
541 "$ref": "../definitions.json#/error"
545 "x-koha-authorization": {
547 "reserveforothers": "1"
552 "x-mojo-to": "Holds#resume",
553 "operationId": "resumeHold",
557 "$ref": "../parameters.json#/hold_id_pp"
560 "consumes": ["application/json"],
561 "produces": ["application/json"],
564 "description": "Hold resumed"
567 "description": "Missing or wrong parameters",
569 "$ref": "../definitions.json#/error"
573 "description": "Authentication required",
575 "$ref": "../definitions.json#/error"
579 "description": "Hold not allowed",
581 "$ref": "../definitions.json#/error"
585 "description": "Hold not found",
587 "$ref": "../definitions.json#/error"
591 "description": "Internal server error",
593 "$ref": "../definitions.json#/error"
597 "description": "Under maintenance",
599 "$ref": "../definitions.json#/error"
603 "x-koha-authorization": {
605 "reserveforothers": "1"