4 x-mojo-to: Checkouts#list
5 operationId: listCheckouts
8 summary: List checkouts
10 - $ref: "../swagger.yaml#/parameters/patron_id_qp"
11 - $ref: "../swagger.yaml#/parameters/page"
12 - $ref: "../swagger.yaml#/parameters/per_page"
13 - $ref: "../swagger.yaml#/parameters/match"
14 - $ref: "../swagger.yaml#/parameters/order_by"
15 - $ref: "../swagger.yaml#/parameters/q_param"
16 - $ref: "../swagger.yaml#/parameters/q_body"
17 - $ref: "../swagger.yaml#/parameters/request_id_header"
20 description: By default, current checkouts are returned, when this is true then
21 checked in checkouts are returned as result.
26 description: Embed list sent as a request header
38 description: A list of checkouts
40 $ref: "../swagger.yaml#/definitions/checkouts"
42 description: Access forbidden
44 $ref: "../swagger.yaml#/definitions/error"
46 description: Patron not found
48 $ref: "../swagger.yaml#/definitions/error"
51 Internal server error. Possible `error_code` attribute values:
53 * `internal_server_error`
55 $ref: "../swagger.yaml#/definitions/error"
57 description: Under maintenance
59 $ref: "../swagger.yaml#/definitions/error"
62 - circulate: circulate_remaining_permissions
63 - circulate: manage_bookings
65 x-mojo-to: Checkouts#add
66 operationId: addCheckout
70 summary: Add a new checkout
74 description: A JSON object containing information about the new checkout
77 $ref: "../swagger.yaml#/definitions/checkout"
80 description: A JWT confirmation token
89 description: Created checkout
91 $ref: "../swagger.yaml#/definitions/checkout"
93 description: Missing or wrong parameters
95 $ref: "../swagger.yaml#/definitions/error"
97 description: Authentication required
99 $ref: "../swagger.yaml#/definitions/error"
101 description: Cannot create checkout
103 $ref: "../swagger.yaml#/definitions/error"
105 description: Conflict in creating checkout
107 $ref: "../swagger.yaml#/definitions/error"
109 description: Precondition failed
111 $ref: "../swagger.yaml#/definitions/error"
114 Internal server error. Possible `error_code` attribute values:
116 * `internal_server_error`
118 $ref: "../swagger.yaml#/definitions/error"
120 description: Under maintenance
122 $ref: "../swagger.yaml#/definitions/error"
123 x-koha-authorization:
125 circulate: circulate_remaining_permissions
126 "/checkouts/{checkout_id}":
128 x-mojo-to: Checkouts#get
129 operationId: getCheckout
132 summary: Get checkout
134 - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
138 description: Embed list sent as a request header
145 collectionFormat: csv
150 description: Updated borrower's checkout
152 $ref: "../swagger.yaml#/definitions/checkout"
154 description: Access forbidden
156 $ref: "../swagger.yaml#/definitions/error"
158 description: Checkout not found
160 $ref: "../swagger.yaml#/definitions/error"
163 Internal server error. Possible `error_code` attribute values:
165 * `internal_server_error`
167 $ref: "../swagger.yaml#/definitions/error"
169 description: Under maintenance
171 $ref: "../swagger.yaml#/definitions/error"
172 x-koha-authorization:
174 circulate: circulate_remaining_permissions
175 "/checkouts/{checkout_id}/renewal":
177 x-mojo-to: Checkouts#renew
178 operationId: renewCheckout
181 summary: Renew a checkout
183 - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
184 - $ref: "../swagger.yaml#/parameters/seen_pp"
189 description: Updated borrower's checkout
191 $ref: "../swagger.yaml#/definitions/checkout"
193 description: Cannot renew checkout
195 $ref: "../swagger.yaml#/definitions/error"
197 description: Checkout not found
199 $ref: "../swagger.yaml#/definitions/error"
202 Internal server error. Possible `error_code` attribute values:
204 * `internal_server_error`
206 $ref: "../swagger.yaml#/definitions/error"
208 description: Under maintenance
210 $ref: "../swagger.yaml#/definitions/error"
211 x-koha-authorization:
213 circulate: circulate_remaining_permissions
214 "/checkouts/{checkout_id}/renewals":
216 x-mojo-to: Checkouts#renew
217 operationId: renewsCheckout
220 summary: Renew a checkout
222 - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
223 - $ref: "../swagger.yaml#/parameters/seen_pp"
228 description: Updated borrower's checkout
230 $ref: "../swagger.yaml#/definitions/checkout"
232 description: Cannot renew checkout
234 $ref: "../swagger.yaml#/definitions/error"
236 description: Checkout not found
238 $ref: "../swagger.yaml#/definitions/error"
241 Internal server error. Possible `error_code` attribute values:
243 * `internal_server_error`
245 $ref: "../swagger.yaml#/definitions/error"
247 description: Under maintenance
249 $ref: "../swagger.yaml#/definitions/error"
250 x-koha-authorization:
252 circulate: circulate_remaining_permissions
254 x-mojo-to: Checkouts#get_renewals
255 operationId: getRenewals
258 summary: List renewals for a checkout
260 - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
264 description: Embed list sent as a request header
270 collectionFormat: csv
275 description: List of checkouts renewals
277 $ref: "../swagger.yaml#/definitions/renewals"
279 description: Access forbidden
281 $ref: "../swagger.yaml#/definitions/error"
283 description: Checkout not found
285 $ref: "../swagger.yaml#/definitions/error"
288 Internal server error. Possible `error_code` attribute values:
290 * `internal_server_error`
292 $ref: "../swagger.yaml#/definitions/error"
294 description: Under maintenance
296 $ref: "../swagger.yaml#/definitions/error"
297 x-koha-authorization:
299 circulate: circulate_remaining_permissions
300 "/checkouts/{checkout_id}/allows_renewal":
302 x-mojo-to: Checkouts#allows_renewal
303 operationId: allows_renewalCheckout
306 summary: Get renewability for a checkout
308 - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
313 description: Checkout renewability information
315 $ref: "../swagger.yaml#/definitions/allows_renewal"
317 description: Forbidden
319 $ref: "../swagger.yaml#/definitions/error"
321 description: Checkout not found
323 $ref: "../swagger.yaml#/definitions/error"
326 Internal server error. Possible `error_code` attribute values:
328 * `internal_server_error`
330 $ref: "../swagger.yaml#/definitions/error"
332 description: Under maintenance
334 $ref: "../swagger.yaml#/definitions/error"
335 x-koha-authorization:
337 circulate: circulate_remaining_permissions
338 "/checkouts/availability":
340 x-mojo-to: Checkouts#get_availability
341 operationId: availabilityCheckouts
344 summary: Get checkout availability
346 - $ref: "../swagger.yaml#/parameters/patron_id_qp"
347 - $ref: "../swagger.yaml#/parameters/item_id_qp"
352 description: Availability
354 $ref: "../swagger.yaml#/definitions/checkout_availability"
356 description: Access forbidden
358 $ref: "../swagger.yaml#/definitions/error"
361 Internal server error. Possible `error_code` attribute values:
363 * `internal_server_error`
365 $ref: "../swagger.yaml#/definitions/error"
367 description: Under maintenance
369 $ref: "../swagger.yaml#/definitions/error"
370 x-koha-authorization:
372 circulate: circulate_remaining_permissions
373 "/public/checkouts/availability":
375 x-mojo-to: Checkouts#get_availability
376 operationId: availabilityCheckoutsPublic
379 summary: Get checkout availability
381 - $ref: "../swagger.yaml#/parameters/patron_id_qp"
382 - $ref: "../swagger.yaml#/parameters/item_id_qp"
387 description: Availability
399 additionalProperties: false
401 description: Access forbidden
403 $ref: "../swagger.yaml#/definitions/error"
406 Internal server error. Possible `error_code` attribute values:
408 * `internal_server_error`
410 $ref: "../swagger.yaml#/definitions/error"
412 description: Under maintenance
414 $ref: "../swagger.yaml#/definitions/error"
415 x-koha-authorization: