Lines 6-120
Link Here
|
6 |
tags: |
6 |
tags: |
7 |
- holds |
7 |
- holds |
8 |
summary: List holds |
8 |
summary: List holds |
|
|
9 |
produces: |
10 |
- application/json |
9 |
parameters: |
11 |
parameters: |
10 |
- name: hold_id |
12 |
- description: Internal hold identifier |
11 |
in: query |
13 |
in: query |
12 |
description: Internal hold identifier |
14 |
name: hold_id |
13 |
type: integer |
15 |
type: integer |
14 |
- name: patron_id |
16 |
- description: Internal patron identifier |
15 |
in: query |
17 |
in: query |
16 |
description: Internal patron identifier |
18 |
name: patron_id |
17 |
type: integer |
19 |
type: integer |
18 |
- name: hold_date |
20 |
- description: Hold |
|
|
21 |
format: date |
19 |
in: query |
22 |
in: query |
20 |
description: Hold |
23 |
name: hold_date |
21 |
type: string |
24 |
type: string |
22 |
format: date |
25 |
- description: Internal biblio identifier |
23 |
- name: biblio_id |
|
|
24 |
in: query |
26 |
in: query |
25 |
description: Internal biblio identifier |
27 |
name: biblio_id |
26 |
type: integer |
28 |
type: integer |
27 |
- name: pickup_library_id |
29 |
- description: Internal library identifier for the pickup library |
28 |
in: query |
30 |
in: query |
29 |
description: Internal library identifier for the pickup library |
31 |
name: pickup_library_id |
30 |
type: string |
32 |
type: string |
31 |
- name: cancellation_date |
33 |
- description: The date the hold was cancelled |
|
|
34 |
format: date |
32 |
in: query |
35 |
in: query |
33 |
description: The date the hold was cancelled |
36 |
name: cancellation_date |
34 |
type: string |
37 |
type: string |
35 |
format: date |
38 |
- description: Notes related to this hold |
36 |
- name: notes |
|
|
37 |
in: query |
39 |
in: query |
38 |
description: Notes related to this hold |
40 |
name: notes |
39 |
type: string |
41 |
type: string |
40 |
- name: priority |
42 |
- description: Where in the queue the patron sits |
41 |
in: query |
43 |
in: query |
42 |
description: Where in the queue the patron sits |
44 |
name: priority |
43 |
type: integer |
45 |
type: integer |
44 |
- name: status |
46 |
- description: Found status |
45 |
in: query |
47 |
in: query |
46 |
description: Found status |
48 |
name: status |
47 |
type: string |
49 |
type: string |
48 |
- name: timestamp |
50 |
- description: Time of latest update |
49 |
in: query |
51 |
in: query |
50 |
description: Time of latest update |
52 |
name: timestamp |
51 |
type: string |
53 |
type: string |
52 |
- name: item_id |
54 |
- description: Internal item identifier |
53 |
in: query |
55 |
in: query |
54 |
description: Internal item identifier |
56 |
name: item_id |
55 |
type: integer |
57 |
type: integer |
56 |
- name: waiting_date |
58 |
- description: Date the item was marked as waiting for the patron |
57 |
in: query |
59 |
in: query |
58 |
description: Date the item was marked as waiting for the patron |
60 |
name: waiting_date |
59 |
type: string |
61 |
type: string |
60 |
- name: expiration_date |
62 |
- description: Date the hold expires |
61 |
in: query |
63 |
in: query |
62 |
description: Date the hold expires |
64 |
name: expiration_date |
63 |
type: string |
65 |
type: string |
64 |
- name: lowest_priority |
66 |
- description: Lowest priority |
65 |
in: query |
67 |
in: query |
66 |
description: Lowest priority |
68 |
name: lowest_priority |
67 |
type: boolean |
69 |
type: boolean |
68 |
- name: suspended |
70 |
- description: Suspended |
69 |
in: query |
71 |
in: query |
70 |
description: Suspended |
72 |
name: suspended |
71 |
type: boolean |
73 |
type: boolean |
72 |
- name: suspended_until |
74 |
- description: Suspended until |
73 |
in: query |
75 |
in: query |
74 |
description: Suspended until |
76 |
name: suspended_until |
75 |
type: string |
77 |
type: string |
76 |
- name: non_priority |
78 |
- description: Non priority hold |
77 |
in: query |
79 |
in: query |
78 |
description: Non priority hold |
80 |
name: non_priority |
79 |
type: boolean |
81 |
type: boolean |
80 |
- $ref: "../swagger.yaml#/parameters/match" |
82 |
- $ref: ../swagger.yaml#/parameters/match |
81 |
- $ref: "../swagger.yaml#/parameters/order_by" |
83 |
- $ref: ../swagger.yaml#/parameters/order_by |
82 |
- $ref: "../swagger.yaml#/parameters/page" |
84 |
- $ref: ../swagger.yaml#/parameters/page |
83 |
- $ref: "../swagger.yaml#/parameters/per_page" |
85 |
- $ref: ../swagger.yaml#/parameters/per_page |
84 |
- $ref: "../swagger.yaml#/parameters/q_param" |
86 |
- $ref: ../swagger.yaml#/parameters/q_param |
85 |
- $ref: "../swagger.yaml#/parameters/q_body" |
87 |
- $ref: ../swagger.yaml#/parameters/q_body |
86 |
- $ref: "../swagger.yaml#/parameters/q_header" |
88 |
- $ref: ../swagger.yaml#/parameters/q_header |
87 |
- $ref: "../swagger.yaml#/parameters/request_id_header" |
89 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
88 |
produces: |
|
|
89 |
- application/json |
90 |
responses: |
90 |
responses: |
91 |
"200": |
91 |
200: |
92 |
description: A list of holds |
92 |
description: A list of holds |
93 |
schema: |
93 |
schema: |
94 |
$ref: "../swagger.yaml#/definitions/holds" |
94 |
$ref: ../swagger.yaml#/definitions/holds |
95 |
"401": |
95 |
401: |
96 |
description: Authentication required |
96 |
description: Authentication required |
97 |
schema: |
97 |
schema: |
98 |
$ref: "../swagger.yaml#/definitions/error" |
98 |
$ref: ../swagger.yaml#/definitions/error |
99 |
"403": |
99 |
403: |
100 |
description: Hold not allowed |
100 |
description: Hold not allowed |
101 |
schema: |
101 |
schema: |
102 |
$ref: "../swagger.yaml#/definitions/error" |
102 |
$ref: ../swagger.yaml#/definitions/error |
103 |
"404": |
103 |
404: |
104 |
description: Borrower not found |
104 |
description: Borrower not found |
105 |
schema: |
105 |
schema: |
106 |
$ref: "../swagger.yaml#/definitions/error" |
106 |
$ref: ../swagger.yaml#/definitions/error |
107 |
"500": |
107 |
500: |
108 |
description: | |
108 |
description: | |
109 |
Internal server error. Possible `error_code` attribute values: |
109 |
Internal server error. Possible `error_code` attribute values: |
110 |
|
110 |
|
111 |
* `internal_server_error` |
111 |
* `internal_server_error` |
112 |
schema: |
112 |
schema: |
113 |
$ref: "../swagger.yaml#/definitions/error" |
113 |
$ref: ../swagger.yaml#/definitions/error |
114 |
"503": |
114 |
503: |
115 |
description: Under maintenance |
115 |
description: Under maintenance |
116 |
schema: |
116 |
schema: |
117 |
$ref: "../swagger.yaml#/definitions/error" |
117 |
$ref: ../swagger.yaml#/definitions/error |
118 |
x-koha-authorization: |
118 |
x-koha-authorization: |
119 |
permissions: |
119 |
permissions: |
120 |
borrowers: edit_borrowers |
120 |
borrowers: edit_borrowers |
Lines 124-170
Link Here
|
124 |
tags: |
124 |
tags: |
125 |
- holds |
125 |
- holds |
126 |
summary: Place hold |
126 |
summary: Place hold |
|
|
127 |
produces: |
128 |
- application/json |
127 |
parameters: |
129 |
parameters: |
128 |
- name: body |
130 |
- description: A JSON object containing informations about the new hold |
129 |
in: body |
131 |
in: body |
130 |
description: A JSON object containing informations about the new hold |
132 |
name: body |
131 |
required: true |
133 |
required: true |
132 |
schema: |
134 |
schema: |
133 |
type: object |
135 |
additionalProperties: false |
134 |
properties: |
136 |
properties: |
135 |
patron_id: |
|
|
136 |
description: Internal patron identifier |
137 |
type: integer |
138 |
biblio_id: |
137 |
biblio_id: |
139 |
description: Internal biblio identifier |
138 |
description: Internal biblio identifier |
140 |
type: |
139 |
type: |
141 |
- integer |
140 |
- integer |
142 |
- "null" |
141 |
- "null" |
|
|
142 |
expiration_date: |
143 |
description: Hold end date |
144 |
format: date |
145 |
type: |
146 |
- string |
147 |
- "null" |
143 |
hold_date: |
148 |
hold_date: |
144 |
description: The date the hold was placed |
149 |
description: The date the hold was placed |
|
|
150 |
format: date |
145 |
type: |
151 |
type: |
146 |
- string |
152 |
- string |
147 |
- "null" |
153 |
- "null" |
148 |
format: date |
|
|
149 |
item_id: |
154 |
item_id: |
150 |
description: Internal item identifier |
155 |
description: Internal item identifier |
151 |
type: |
156 |
type: |
152 |
- integer |
157 |
- integer |
153 |
- "null" |
158 |
- "null" |
154 |
pickup_library_id: |
|
|
155 |
description: Internal library identifier for the pickup library |
156 |
type: string |
157 |
expiration_date: |
158 |
description: Hold end date |
159 |
type: |
160 |
- string |
161 |
- "null" |
162 |
format: date |
163 |
notes: |
164 |
description: Notes related to this hold |
165 |
type: |
166 |
- string |
167 |
- "null" |
168 |
item_type: |
159 |
item_type: |
169 |
description: Limit hold on one itemtype (ignored for item-level holds) |
160 |
description: Limit hold on one itemtype (ignored for item-level holds) |
170 |
type: |
161 |
type: |
Lines 175-679
Link Here
|
175 |
type: |
166 |
type: |
176 |
- boolean |
167 |
- boolean |
177 |
- "null" |
168 |
- "null" |
|
|
169 |
notes: |
170 |
description: Notes related to this hold |
171 |
type: |
172 |
- string |
173 |
- "null" |
174 |
patron_id: |
175 |
description: Internal patron identifier |
176 |
type: integer |
177 |
pickup_library_id: |
178 |
description: Internal library identifier for the pickup library |
179 |
type: string |
178 |
required: |
180 |
required: |
179 |
- patron_id |
181 |
- patron_id |
180 |
- pickup_library_id |
182 |
- pickup_library_id |
181 |
additionalProperties: false |
183 |
type: object |
182 |
- name: x-koha-override |
184 |
- description: 'Comma-separated list of overrides (valid values: any)' |
183 |
description: "Comma-separated list of overrides (valid values: any)" |
|
|
184 |
in: header |
185 |
in: header |
185 |
type: string |
186 |
name: x-koha-override |
186 |
required: false |
187 |
required: false |
187 |
consumes: |
188 |
type: string |
188 |
- application/json |
|
|
189 |
produces: |
190 |
- application/json |
191 |
responses: |
189 |
responses: |
192 |
"201": |
190 |
201: |
193 |
description: Created hold |
191 |
description: Created hold |
194 |
schema: |
192 |
schema: |
195 |
$ref: "../swagger.yaml#/definitions/hold" |
193 |
$ref: ../swagger.yaml#/definitions/hold |
196 |
"400": |
194 |
400: |
197 |
description: Missing or wrong parameters |
195 |
description: Missing or wrong parameters |
198 |
schema: |
196 |
schema: |
199 |
$ref: "../swagger.yaml#/definitions/error" |
197 |
$ref: ../swagger.yaml#/definitions/error |
200 |
"401": |
198 |
401: |
201 |
description: Authentication required |
199 |
description: Authentication required |
202 |
schema: |
200 |
schema: |
203 |
$ref: "../swagger.yaml#/definitions/error" |
201 |
$ref: ../swagger.yaml#/definitions/error |
204 |
"403": |
202 |
403: |
205 |
description: Hold not allowed |
203 |
description: Hold not allowed |
206 |
schema: |
204 |
schema: |
207 |
$ref: "../swagger.yaml#/definitions/error" |
205 |
$ref: ../swagger.yaml#/definitions/error |
208 |
"404": |
206 |
404: |
209 |
description: Borrower not found |
207 |
description: Borrower not found |
210 |
schema: |
208 |
schema: |
211 |
$ref: "../swagger.yaml#/definitions/error" |
209 |
$ref: ../swagger.yaml#/definitions/error |
212 |
"500": |
210 |
500: |
213 |
description: | |
211 |
description: | |
214 |
Internal server error. Possible `error_code` attribute values: |
212 |
Internal server error. Possible `error_code` attribute values: |
215 |
|
213 |
|
216 |
* `internal_server_error` |
214 |
* `internal_server_error` |
217 |
schema: |
215 |
schema: |
218 |
$ref: "../swagger.yaml#/definitions/error" |
216 |
$ref: ../swagger.yaml#/definitions/error |
219 |
"503": |
217 |
503: |
220 |
description: Under maintenance |
218 |
description: Under maintenance |
221 |
schema: |
219 |
schema: |
222 |
$ref: "../swagger.yaml#/definitions/error" |
220 |
$ref: ../swagger.yaml#/definitions/error |
223 |
x-koha-authorization: |
221 |
x-koha-authorization: |
224 |
permissions: |
222 |
permissions: |
225 |
reserveforothers: "1" |
223 |
reserveforothers: 1 |
226 |
"/holds/{hold_id}": |
224 |
consumes: |
|
|
225 |
- application/json |
226 |
'/holds/{hold_id}': |
227 |
delete: |
228 |
x-mojo-to: Holds#delete |
229 |
operationId: deleteHold |
230 |
tags: |
231 |
- holds |
232 |
summary: Cancel hold |
233 |
produces: |
234 |
- application/json |
235 |
parameters: |
236 |
- $ref: ../swagger.yaml#/parameters/hold_id_pp |
237 |
responses: |
238 |
204: |
239 |
description: Hold deleted |
240 |
401: |
241 |
description: Authentication required |
242 |
schema: |
243 |
$ref: ../swagger.yaml#/definitions/error |
244 |
403: |
245 |
description: Hold not allowed |
246 |
schema: |
247 |
$ref: ../swagger.yaml#/definitions/error |
248 |
404: |
249 |
description: Hold not found |
250 |
schema: |
251 |
$ref: ../swagger.yaml#/definitions/error |
252 |
500: |
253 |
description: | |
254 |
Internal server error. Possible `error_code` attribute values: |
255 |
|
256 |
* `internal_server_error` |
257 |
schema: |
258 |
$ref: ../swagger.yaml#/definitions/error |
259 |
503: |
260 |
description: Under maintenance |
261 |
schema: |
262 |
$ref: ../swagger.yaml#/definitions/error |
263 |
x-koha-authorization: |
264 |
permissions: |
265 |
reserveforothers: 1 |
227 |
patch: |
266 |
patch: |
228 |
x-mojo-to: Holds#edit |
267 |
x-mojo-to: Holds#edit |
229 |
operationId: editHold |
268 |
operationId: editHold |
230 |
tags: |
269 |
tags: |
231 |
- holds |
270 |
- holds |
232 |
summary: Update hold |
271 |
summary: Update hold |
|
|
272 |
produces: |
273 |
- application/json |
233 |
parameters: |
274 |
parameters: |
234 |
- $ref: "../swagger.yaml#/parameters/hold_id_pp" |
275 |
- $ref: ../swagger.yaml#/parameters/hold_id_pp |
235 |
- name: body |
276 |
- description: A JSON object containing fields to modify |
236 |
in: body |
277 |
in: body |
237 |
description: A JSON object containing fields to modify |
278 |
name: body |
238 |
required: true |
279 |
required: true |
239 |
schema: |
280 |
schema: |
240 |
type: object |
281 |
additionalProperties: false |
241 |
properties: |
282 |
properties: |
242 |
priority: |
|
|
243 |
description: Position in waiting queue |
244 |
type: integer |
245 |
minimum: 1 |
246 |
pickup_library_id: |
283 |
pickup_library_id: |
247 |
description: Internal library identifier for the pickup library |
284 |
description: Internal library identifier for the pickup library |
248 |
type: string |
285 |
type: string |
|
|
286 |
priority: |
287 |
description: Position in waiting queue |
288 |
minimum: 1 |
289 |
type: integer |
249 |
suspended_until: |
290 |
suspended_until: |
250 |
description: Date until which the hold has been suspended |
291 |
description: Date until which the hold has been suspended |
251 |
type: string |
|
|
252 |
format: date-time |
292 |
format: date-time |
253 |
additionalProperties: false |
293 |
type: string |
254 |
consumes: |
294 |
type: object |
255 |
- application/json |
|
|
256 |
produces: |
257 |
- application/json |
258 |
responses: |
295 |
responses: |
259 |
"200": |
296 |
200: |
260 |
description: Updated hold |
297 |
description: Updated hold |
261 |
schema: |
298 |
schema: |
262 |
$ref: "../swagger.yaml#/definitions/hold" |
299 |
$ref: ../swagger.yaml#/definitions/hold |
263 |
"400": |
300 |
400: |
264 |
description: Missing or wrong parameters |
301 |
description: Missing or wrong parameters |
265 |
schema: |
302 |
schema: |
266 |
$ref: "../swagger.yaml#/definitions/error" |
303 |
$ref: ../swagger.yaml#/definitions/error |
267 |
"401": |
304 |
401: |
268 |
description: Authentication required |
305 |
description: Authentication required |
269 |
schema: |
306 |
schema: |
270 |
$ref: "../swagger.yaml#/definitions/error" |
307 |
$ref: ../swagger.yaml#/definitions/error |
271 |
"403": |
308 |
403: |
272 |
description: Hold not allowed |
309 |
description: Hold not allowed |
273 |
schema: |
310 |
schema: |
274 |
$ref: "../swagger.yaml#/definitions/error" |
311 |
$ref: ../swagger.yaml#/definitions/error |
275 |
"404": |
312 |
404: |
276 |
description: Hold not found |
313 |
description: Hold not found |
277 |
schema: |
314 |
schema: |
278 |
$ref: "../swagger.yaml#/definitions/error" |
315 |
$ref: ../swagger.yaml#/definitions/error |
279 |
"500": |
316 |
500: |
280 |
description: | |
317 |
description: | |
281 |
Internal server error. Possible `error_code` attribute values: |
318 |
Internal server error. Possible `error_code` attribute values: |
282 |
|
319 |
|
283 |
* `internal_server_error` |
320 |
* `internal_server_error` |
284 |
schema: |
321 |
schema: |
285 |
$ref: "../swagger.yaml#/definitions/error" |
322 |
$ref: ../swagger.yaml#/definitions/error |
286 |
"503": |
323 |
503: |
287 |
description: Under maintenance |
324 |
description: Under maintenance |
288 |
schema: |
325 |
schema: |
289 |
$ref: "../swagger.yaml#/definitions/error" |
326 |
$ref: ../swagger.yaml#/definitions/error |
290 |
x-koha-authorization: |
327 |
x-koha-authorization: |
291 |
permissions: |
328 |
permissions: |
292 |
reserveforothers: "1" |
329 |
reserveforothers: 1 |
|
|
330 |
consumes: |
331 |
- application/json |
293 |
put: |
332 |
put: |
294 |
x-mojo-to: Holds#edit |
333 |
x-mojo-to: Holds#edit |
295 |
operationId: overwriteHold |
334 |
operationId: overwriteHold |
296 |
tags: |
335 |
tags: |
297 |
- holds |
336 |
- holds |
298 |
summary: Update hold |
337 |
summary: Update hold |
299 |
description: This route is being deprecated and will be removed in future releases. |
338 |
produces: |
300 |
Please migrate your project to use PATCH /holds/{hold_id} instead. |
339 |
- application/json |
301 |
parameters: |
340 |
parameters: |
302 |
- $ref: "../swagger.yaml#/parameters/hold_id_pp" |
341 |
- $ref: ../swagger.yaml#/parameters/hold_id_pp |
303 |
- name: body |
342 |
- description: A JSON object containing fields to modify |
304 |
in: body |
343 |
in: body |
305 |
description: A JSON object containing fields to modify |
344 |
name: body |
306 |
required: true |
345 |
required: true |
307 |
schema: |
346 |
schema: |
308 |
type: object |
347 |
additionalProperties: false |
309 |
properties: |
348 |
properties: |
310 |
priority: |
|
|
311 |
description: Position in waiting queue |
312 |
type: integer |
313 |
minimum: 1 |
314 |
pickup_library_id: |
349 |
pickup_library_id: |
315 |
description: Internal library identifier for the pickup library |
350 |
description: Internal library identifier for the pickup library |
316 |
type: string |
351 |
type: string |
|
|
352 |
priority: |
353 |
description: Position in waiting queue |
354 |
minimum: 1 |
355 |
type: integer |
317 |
suspended_until: |
356 |
suspended_until: |
318 |
description: Date until which the hold has been suspended |
357 |
description: Date until which the hold has been suspended |
319 |
type: string |
|
|
320 |
format: date-time |
358 |
format: date-time |
321 |
additionalProperties: false |
359 |
type: string |
322 |
consumes: |
360 |
type: object |
323 |
- application/json |
|
|
324 |
produces: |
325 |
- application/json |
326 |
responses: |
361 |
responses: |
327 |
"200": |
362 |
200: |
328 |
description: Updated hold |
363 |
description: Updated hold |
329 |
schema: |
364 |
schema: |
330 |
$ref: "../swagger.yaml#/definitions/hold" |
365 |
$ref: ../swagger.yaml#/definitions/hold |
331 |
"400": |
366 |
400: |
332 |
description: Missing or wrong parameters |
367 |
description: Missing or wrong parameters |
333 |
schema: |
368 |
schema: |
334 |
$ref: "../swagger.yaml#/definitions/error" |
369 |
$ref: ../swagger.yaml#/definitions/error |
335 |
"401": |
370 |
401: |
336 |
description: Authentication required |
371 |
description: Authentication required |
337 |
schema: |
372 |
schema: |
338 |
$ref: "../swagger.yaml#/definitions/error" |
373 |
$ref: ../swagger.yaml#/definitions/error |
339 |
"403": |
374 |
403: |
340 |
description: Hold not allowed |
375 |
description: Hold not allowed |
341 |
schema: |
376 |
schema: |
342 |
$ref: "../swagger.yaml#/definitions/error" |
377 |
$ref: ../swagger.yaml#/definitions/error |
343 |
"404": |
378 |
404: |
344 |
description: Hold not found |
379 |
description: Hold not found |
345 |
schema: |
380 |
schema: |
346 |
$ref: "../swagger.yaml#/definitions/error" |
381 |
$ref: ../swagger.yaml#/definitions/error |
347 |
"500": |
382 |
500: |
348 |
description: | |
383 |
description: | |
349 |
Internal server error. Possible `error_code` attribute values: |
384 |
Internal server error. Possible `error_code` attribute values: |
350 |
|
385 |
|
351 |
* `internal_server_error` |
386 |
* `internal_server_error` |
352 |
schema: |
387 |
schema: |
353 |
$ref: "../swagger.yaml#/definitions/error" |
388 |
$ref: ../swagger.yaml#/definitions/error |
354 |
"503": |
389 |
503: |
355 |
description: Under maintenance |
390 |
description: Under maintenance |
356 |
schema: |
391 |
schema: |
357 |
$ref: "../swagger.yaml#/definitions/error" |
392 |
$ref: ../swagger.yaml#/definitions/error |
358 |
x-koha-authorization: |
393 |
x-koha-authorization: |
359 |
permissions: |
394 |
permissions: |
360 |
reserveforothers: "1" |
395 |
reserveforothers: 1 |
361 |
delete: |
396 |
description: 'This route is being deprecated and will be removed in future releases. Please migrate your project to use PATCH /holds/{hold_id} instead.' |
362 |
x-mojo-to: Holds#delete |
397 |
consumes: |
363 |
operationId: deleteHold |
398 |
- application/json |
|
|
399 |
'/holds/{hold_id}/pickup_location': |
400 |
put: |
401 |
x-mojo-to: Holds#update_pickup_location |
402 |
operationId: updateHoldPickupLocation |
364 |
tags: |
403 |
tags: |
365 |
- holds |
404 |
- holds |
366 |
summary: Cancel hold |
405 |
summary: Update pickup location for the hold |
367 |
parameters: |
|
|
368 |
- $ref: "../swagger.yaml#/parameters/hold_id_pp" |
369 |
produces: |
406 |
produces: |
370 |
- application/json |
407 |
- application/json |
|
|
408 |
parameters: |
409 |
- $ref: ../swagger.yaml#/parameters/hold_id_pp |
410 |
- description: Pickup location |
411 |
in: body |
412 |
name: body |
413 |
required: true |
414 |
schema: |
415 |
additionalProperties: false |
416 |
properties: |
417 |
pickup_library_id: |
418 |
description: Internal identifier for the pickup library |
419 |
type: string |
420 |
type: object |
371 |
responses: |
421 |
responses: |
372 |
"204": |
422 |
200: |
373 |
description: Hold deleted |
423 |
description: The new pickup location value for the hold |
374 |
"401": |
424 |
schema: |
|
|
425 |
type: object |
426 |
properties: |
427 |
pickup_library_id: |
428 |
description: Internal identifier for the pickup library |
429 |
type: string |
430 |
additionalProperties: false |
431 |
400: |
432 |
description: Missing or wrong parameters |
433 |
schema: |
434 |
$ref: ../swagger.yaml#/definitions/error |
435 |
401: |
375 |
description: Authentication required |
436 |
description: Authentication required |
376 |
schema: |
437 |
schema: |
377 |
$ref: "../swagger.yaml#/definitions/error" |
438 |
$ref: ../swagger.yaml#/definitions/error |
378 |
"403": |
439 |
403: |
379 |
description: Hold not allowed |
440 |
description: Access forbidden |
380 |
schema: |
441 |
schema: |
381 |
$ref: "../swagger.yaml#/definitions/error" |
442 |
$ref: ../swagger.yaml#/definitions/error |
382 |
"404": |
443 |
404: |
383 |
description: Hold not found |
444 |
description: Hold not found |
384 |
schema: |
445 |
schema: |
385 |
$ref: "../swagger.yaml#/definitions/error" |
446 |
$ref: ../swagger.yaml#/definitions/error |
386 |
"500": |
447 |
409: |
387 |
description: | |
448 |
description: Unable to perform action on hold |
388 |
Internal server error. Possible `error_code` attribute values: |
449 |
schema: |
389 |
|
450 |
$ref: ../swagger.yaml#/definitions/error |
390 |
* `internal_server_error` |
451 |
500: |
|
|
452 |
description: Internal error |
391 |
schema: |
453 |
schema: |
392 |
$ref: "../swagger.yaml#/definitions/error" |
454 |
$ref: ../swagger.yaml#/definitions/error |
393 |
"503": |
455 |
503: |
394 |
description: Under maintenance |
456 |
description: Under maintenance |
395 |
schema: |
457 |
schema: |
396 |
$ref: "../swagger.yaml#/definitions/error" |
458 |
$ref: ../swagger.yaml#/definitions/error |
397 |
x-koha-authorization: |
459 |
x-koha-authorization: |
398 |
permissions: |
460 |
permissions: |
399 |
reserveforothers: "1" |
461 |
reserveforothers: place_holds |
400 |
"/holds/{hold_id}/priority": |
462 |
description: Set a new pickup location for the hold |
401 |
put: |
463 |
'/holds/{hold_id}/pickup_locations': |
402 |
x-mojo-to: Holds#update_priority |
464 |
get: |
403 |
operationId: updateHoldPriority |
465 |
x-mojo-to: Holds#pickup_locations |
|
|
466 |
operationId: getHoldPickupLocations |
404 |
tags: |
467 |
tags: |
405 |
- holds |
468 |
- holds |
406 |
summary: Update priority for the hold |
469 |
summary: Get valid pickup locations for hold |
407 |
parameters: |
|
|
408 |
- $ref: "../swagger.yaml#/parameters/hold_id_pp" |
409 |
- name: body |
410 |
in: body |
411 |
description: An integer representing the new priority to be set for the hold |
412 |
required: true |
413 |
schema: |
414 |
type: integer |
415 |
produces: |
470 |
produces: |
416 |
- application/json |
471 |
- application/json |
|
|
472 |
parameters: |
473 |
- description: 'Comma-separated list of overrides (valid values: any)' |
474 |
in: header |
475 |
name: x-koha-override |
476 |
required: false |
477 |
type: string |
478 |
- $ref: ../swagger.yaml#/parameters/hold_id_pp |
479 |
- $ref: ../swagger.yaml#/parameters/match |
480 |
- $ref: ../swagger.yaml#/parameters/order_by |
481 |
- $ref: ../swagger.yaml#/parameters/page |
482 |
- $ref: ../swagger.yaml#/parameters/per_page |
483 |
- $ref: ../swagger.yaml#/parameters/q_param |
484 |
- $ref: ../swagger.yaml#/parameters/q_body |
485 |
- $ref: ../swagger.yaml#/parameters/q_header |
486 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
417 |
responses: |
487 |
responses: |
418 |
"200": |
488 |
200: |
419 |
description: The new priority value for the hold |
489 |
description: Hold pickup location |
420 |
schema: |
490 |
schema: |
421 |
type: integer |
491 |
type: array |
422 |
"401": |
492 |
items: |
423 |
description: Authentication required |
493 |
$ref: ../swagger.yaml#/definitions/library |
|
|
494 |
400: |
495 |
description: Missing or wrong parameters |
424 |
schema: |
496 |
schema: |
425 |
$ref: "../swagger.yaml#/definitions/error" |
497 |
$ref: ../swagger.yaml#/definitions/error |
426 |
"403": |
498 |
401: |
427 |
description: Access forbidden |
499 |
description: Authentication required |
428 |
schema: |
500 |
schema: |
429 |
$ref: "../swagger.yaml#/definitions/error" |
501 |
$ref: ../swagger.yaml#/definitions/error |
430 |
"404": |
502 |
403: |
431 |
description: Biblio not found |
503 |
description: Hold pickup location list not allowed |
432 |
schema: |
504 |
schema: |
433 |
$ref: "../swagger.yaml#/definitions/error" |
505 |
$ref: ../swagger.yaml#/definitions/error |
434 |
"409": |
506 |
404: |
435 |
description: Unable to perform action on biblio |
507 |
description: Hold not found |
436 |
schema: |
508 |
schema: |
437 |
$ref: "../swagger.yaml#/definitions/error" |
509 |
$ref: ../swagger.yaml#/definitions/error |
438 |
"500": |
510 |
500: |
439 |
description: | |
511 |
description: | |
440 |
Internal server error. Possible `error_code` attribute values: |
512 |
Internal server error. Possible `error_code` attribute values: |
441 |
|
513 |
|
442 |
* `internal_server_error` |
514 |
* `internal_server_error` |
443 |
schema: |
515 |
schema: |
444 |
$ref: "../swagger.yaml#/definitions/error" |
516 |
$ref: ../swagger.yaml#/definitions/error |
445 |
"503": |
517 |
503: |
446 |
description: Under maintenance |
518 |
description: Under maintenance |
447 |
schema: |
519 |
schema: |
448 |
$ref: "../swagger.yaml#/definitions/error" |
520 |
$ref: ../swagger.yaml#/definitions/error |
449 |
x-koha-authorization: |
521 |
x-koha-authorization: |
450 |
permissions: |
522 |
permissions: |
451 |
reserveforothers: modify_holds_priority |
523 |
reserveforothers: place_holds |
452 |
"/holds/{hold_id}/suspension": |
524 |
'/holds/{hold_id}/priority': |
453 |
post: |
525 |
put: |
454 |
x-mojo-to: Holds#suspend |
526 |
x-mojo-to: Holds#update_priority |
455 |
operationId: suspendHold |
527 |
operationId: updateHoldPriority |
456 |
tags: |
528 |
tags: |
457 |
- holds |
529 |
- holds |
458 |
summary: Suspend the hold |
530 |
summary: Update priority for the hold |
|
|
531 |
produces: |
532 |
- application/json |
459 |
parameters: |
533 |
parameters: |
460 |
- $ref: "../swagger.yaml#/parameters/hold_id_pp" |
534 |
- $ref: ../swagger.yaml#/parameters/hold_id_pp |
461 |
- name: body |
535 |
- description: An integer representing the new priority to be set for the hold |
462 |
in: body |
536 |
in: body |
463 |
description: A JSON object containing fields to modify |
537 |
name: body |
464 |
required: false |
538 |
required: true |
465 |
schema: |
539 |
schema: |
466 |
type: object |
540 |
type: integer |
467 |
properties: |
|
|
468 |
end_date: |
469 |
description: Date the hold suspension expires |
470 |
type: string |
471 |
format: date |
472 |
additionalProperties: false |
473 |
consumes: |
474 |
- application/json |
475 |
produces: |
476 |
- application/json |
477 |
responses: |
541 |
responses: |
478 |
"201": |
542 |
200: |
479 |
description: Hold suspended |
543 |
description: The new priority value for the hold |
480 |
"400": |
|
|
481 |
description: Missing or wrong parameters |
482 |
schema: |
544 |
schema: |
483 |
$ref: "../swagger.yaml#/definitions/error" |
545 |
type: integer |
484 |
"401": |
546 |
401: |
485 |
description: Authentication required |
547 |
description: Authentication required |
486 |
schema: |
548 |
schema: |
487 |
$ref: "../swagger.yaml#/definitions/error" |
549 |
$ref: ../swagger.yaml#/definitions/error |
488 |
"403": |
550 |
403: |
489 |
description: Hold not allowed |
551 |
description: Access forbidden |
490 |
schema: |
552 |
schema: |
491 |
$ref: "../swagger.yaml#/definitions/error" |
553 |
$ref: ../swagger.yaml#/definitions/error |
492 |
"404": |
554 |
404: |
493 |
description: Hold not found |
555 |
description: Biblio not found |
494 |
schema: |
556 |
schema: |
495 |
$ref: "../swagger.yaml#/definitions/error" |
557 |
$ref: ../swagger.yaml#/definitions/error |
496 |
"500": |
558 |
409: |
|
|
559 |
description: Unable to perform action on biblio |
560 |
schema: |
561 |
$ref: ../swagger.yaml#/definitions/error |
562 |
500: |
497 |
description: | |
563 |
description: | |
498 |
Internal server error. Possible `error_code` attribute values: |
564 |
Internal server error. Possible `error_code` attribute values: |
499 |
|
565 |
|
500 |
* `internal_server_error` |
566 |
* `internal_server_error` |
501 |
schema: |
567 |
schema: |
502 |
$ref: "../swagger.yaml#/definitions/error" |
568 |
$ref: ../swagger.yaml#/definitions/error |
503 |
"503": |
569 |
503: |
504 |
description: Under maintenance |
570 |
description: Under maintenance |
505 |
schema: |
571 |
schema: |
506 |
$ref: "../swagger.yaml#/definitions/error" |
572 |
$ref: ../swagger.yaml#/definitions/error |
507 |
x-koha-authorization: |
573 |
x-koha-authorization: |
508 |
permissions: |
574 |
permissions: |
509 |
reserveforothers: "1" |
575 |
reserveforothers: modify_holds_priority |
|
|
576 |
'/holds/{hold_id}/suspension': |
510 |
delete: |
577 |
delete: |
511 |
x-mojo-to: Holds#resume |
578 |
x-mojo-to: Holds#resume |
512 |
operationId: resumeHold |
579 |
operationId: resumeHold |
513 |
tags: |
580 |
tags: |
514 |
- holds |
581 |
- holds |
515 |
summary: Resume hold |
582 |
summary: Resume hold |
516 |
parameters: |
|
|
517 |
- $ref: "../swagger.yaml#/parameters/hold_id_pp" |
518 |
consumes: |
519 |
- application/json |
520 |
produces: |
583 |
produces: |
521 |
- application/json |
584 |
- application/json |
|
|
585 |
parameters: |
586 |
- $ref: ../swagger.yaml#/parameters/hold_id_pp |
522 |
responses: |
587 |
responses: |
523 |
"204": |
588 |
204: |
524 |
description: Hold resumed |
589 |
description: Hold resumed |
525 |
"400": |
590 |
400: |
526 |
description: Missing or wrong parameters |
591 |
description: Missing or wrong parameters |
527 |
schema: |
592 |
schema: |
528 |
$ref: "../swagger.yaml#/definitions/error" |
593 |
$ref: ../swagger.yaml#/definitions/error |
529 |
"401": |
594 |
401: |
530 |
description: Authentication required |
595 |
description: Authentication required |
531 |
schema: |
596 |
schema: |
532 |
$ref: "../swagger.yaml#/definitions/error" |
597 |
$ref: ../swagger.yaml#/definitions/error |
533 |
"403": |
598 |
403: |
534 |
description: Hold not allowed |
599 |
description: Hold not allowed |
535 |
schema: |
600 |
schema: |
536 |
$ref: "../swagger.yaml#/definitions/error" |
601 |
$ref: ../swagger.yaml#/definitions/error |
537 |
"404": |
602 |
404: |
538 |
description: Hold not found |
603 |
description: Hold not found |
539 |
schema: |
604 |
schema: |
540 |
$ref: "../swagger.yaml#/definitions/error" |
605 |
$ref: ../swagger.yaml#/definitions/error |
541 |
"500": |
606 |
500: |
542 |
description: | |
607 |
description: | |
543 |
Internal server error. Possible `error_code` attribute values: |
608 |
Internal server error. Possible `error_code` attribute values: |
544 |
|
609 |
|
545 |
* `internal_server_error` |
610 |
* `internal_server_error` |
546 |
schema: |
611 |
schema: |
547 |
$ref: "../swagger.yaml#/definitions/error" |
612 |
$ref: ../swagger.yaml#/definitions/error |
548 |
"503": |
613 |
503: |
549 |
description: Under maintenance |
614 |
description: Under maintenance |
550 |
schema: |
615 |
schema: |
551 |
$ref: "../swagger.yaml#/definitions/error" |
616 |
$ref: ../swagger.yaml#/definitions/error |
552 |
x-koha-authorization: |
617 |
x-koha-authorization: |
553 |
permissions: |
618 |
permissions: |
554 |
reserveforothers: "1" |
619 |
reserveforothers: 1 |
555 |
"/holds/{hold_id}/pickup_locations": |
620 |
consumes: |
556 |
get: |
621 |
- application/json |
557 |
x-mojo-to: Holds#pickup_locations |
622 |
post: |
558 |
operationId: getHoldPickupLocations |
623 |
x-mojo-to: Holds#suspend |
|
|
624 |
operationId: suspendHold |
559 |
tags: |
625 |
tags: |
560 |
- holds |
626 |
- holds |
561 |
summary: Get valid pickup locations for hold |
627 |
summary: Suspend the hold |
562 |
parameters: |
|
|
563 |
- name: x-koha-override |
564 |
description: "Comma-separated list of overrides (valid values: any)" |
565 |
in: header |
566 |
type: string |
567 |
required: false |
568 |
- $ref: "../swagger.yaml#/parameters/hold_id_pp" |
569 |
- $ref: "../swagger.yaml#/parameters/match" |
570 |
- $ref: "../swagger.yaml#/parameters/order_by" |
571 |
- $ref: "../swagger.yaml#/parameters/page" |
572 |
- $ref: "../swagger.yaml#/parameters/per_page" |
573 |
- $ref: "../swagger.yaml#/parameters/q_param" |
574 |
- $ref: "../swagger.yaml#/parameters/q_body" |
575 |
- $ref: "../swagger.yaml#/parameters/q_header" |
576 |
- $ref: "../swagger.yaml#/parameters/request_id_header" |
577 |
produces: |
628 |
produces: |
578 |
- application/json |
629 |
- application/json |
579 |
responses: |
|
|
580 |
"200": |
581 |
description: Hold pickup location |
582 |
schema: |
583 |
type: array |
584 |
items: |
585 |
$ref: "../swagger.yaml#/definitions/library" |
586 |
"400": |
587 |
description: Missing or wrong parameters |
588 |
schema: |
589 |
$ref: "../swagger.yaml#/definitions/error" |
590 |
"401": |
591 |
description: Authentication required |
592 |
schema: |
593 |
$ref: "../swagger.yaml#/definitions/error" |
594 |
"403": |
595 |
description: Hold pickup location list not allowed |
596 |
schema: |
597 |
$ref: "../swagger.yaml#/definitions/error" |
598 |
"404": |
599 |
description: Hold not found |
600 |
schema: |
601 |
$ref: "../swagger.yaml#/definitions/error" |
602 |
"500": |
603 |
description: | |
604 |
Internal server error. Possible `error_code` attribute values: |
605 |
|
606 |
* `internal_server_error` |
607 |
schema: |
608 |
$ref: "../swagger.yaml#/definitions/error" |
609 |
"503": |
610 |
description: Under maintenance |
611 |
schema: |
612 |
$ref: "../swagger.yaml#/definitions/error" |
613 |
x-koha-authorization: |
614 |
permissions: |
615 |
reserveforothers: place_holds |
616 |
"/holds/{hold_id}/pickup_location": |
617 |
put: |
618 |
x-mojo-to: Holds#update_pickup_location |
619 |
operationId: updateHoldPickupLocation |
620 |
tags: |
621 |
- holds |
622 |
summary: Update pickup location for the hold |
623 |
description: Set a new pickup location for the hold |
624 |
parameters: |
630 |
parameters: |
625 |
- $ref: "../swagger.yaml#/parameters/hold_id_pp" |
631 |
- $ref: ../swagger.yaml#/parameters/hold_id_pp |
626 |
- name: body |
632 |
- description: A JSON object containing fields to modify |
627 |
in: body |
633 |
in: body |
628 |
description: Pickup location |
634 |
name: body |
629 |
required: true |
635 |
required: false |
630 |
schema: |
636 |
schema: |
631 |
type: object |
|
|
632 |
properties: |
633 |
pickup_library_id: |
634 |
type: string |
635 |
description: Internal identifier for the pickup library |
636 |
additionalProperties: false |
637 |
additionalProperties: false |
637 |
produces: |
|
|
638 |
- application/json |
639 |
responses: |
640 |
"200": |
641 |
description: The new pickup location value for the hold |
642 |
schema: |
643 |
type: object |
644 |
properties: |
638 |
properties: |
645 |
pickup_library_id: |
639 |
end_date: |
|
|
640 |
description: Date the hold suspension expires |
641 |
format: date |
646 |
type: string |
642 |
type: string |
647 |
description: Internal identifier for the pickup library |
643 |
type: object |
648 |
additionalProperties: false |
644 |
responses: |
649 |
"400": |
645 |
201: |
|
|
646 |
description: Hold suspended |
647 |
400: |
650 |
description: Missing or wrong parameters |
648 |
description: Missing or wrong parameters |
651 |
schema: |
649 |
schema: |
652 |
$ref: "../swagger.yaml#/definitions/error" |
650 |
$ref: ../swagger.yaml#/definitions/error |
653 |
"401": |
651 |
401: |
654 |
description: Authentication required |
652 |
description: Authentication required |
655 |
schema: |
653 |
schema: |
656 |
$ref: "../swagger.yaml#/definitions/error" |
654 |
$ref: ../swagger.yaml#/definitions/error |
657 |
"403": |
655 |
403: |
658 |
description: Access forbidden |
656 |
description: Hold not allowed |
659 |
schema: |
657 |
schema: |
660 |
$ref: "../swagger.yaml#/definitions/error" |
658 |
$ref: ../swagger.yaml#/definitions/error |
661 |
"404": |
659 |
404: |
662 |
description: Hold not found |
660 |
description: Hold not found |
663 |
schema: |
661 |
schema: |
664 |
$ref: "../swagger.yaml#/definitions/error" |
662 |
$ref: ../swagger.yaml#/definitions/error |
665 |
"409": |
663 |
500: |
666 |
description: Unable to perform action on hold |
664 |
description: | |
667 |
schema: |
665 |
Internal server error. Possible `error_code` attribute values: |
668 |
$ref: "../swagger.yaml#/definitions/error" |
666 |
|
669 |
"500": |
667 |
* `internal_server_error` |
670 |
description: Internal error |
|
|
671 |
schema: |
668 |
schema: |
672 |
$ref: "../swagger.yaml#/definitions/error" |
669 |
$ref: ../swagger.yaml#/definitions/error |
673 |
"503": |
670 |
503: |
674 |
description: Under maintenance |
671 |
description: Under maintenance |
675 |
schema: |
672 |
schema: |
676 |
$ref: "../swagger.yaml#/definitions/error" |
673 |
$ref: ../swagger.yaml#/definitions/error |
677 |
x-koha-authorization: |
674 |
x-koha-authorization: |
678 |
permissions: |
675 |
permissions: |
679 |
reserveforothers: place_holds |
676 |
reserveforothers: 1 |
|
|
677 |
consumes: |
678 |
- application/json |